• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/erp_fin/fcx_fluxocaixa
Mais pesquisados:Customização, Tutorial, Documentação

fcx_fluxocaixa

316 views 0 22/10/2018 Atualizado em 09/11/2026 integrador

2.0info: 17.2.0 fcx_fluxocaixa description: Serviço de Fluxo de Caixa x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: fcx_fluxocaixa 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/erp_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /fcx_fluxocaixa/queries/consultarParametrizacaoRapida: post: description: Permite consultar a parametrizaçãoo pelo código ou descrição. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – termoBusca properties: termoBusca: type: string description: Código ou descrição da parametrizaçõa. responses: 200: description: Ok schema: type: object required: – parametrizacao properties: parametrizacao: type: array items: type: object allOf: – #/definitions/consultaInformacoesRapida minimum: 1 description: Registros de parametrização retornados contendo o código e a descrição da parametrização. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Permite consultar a parametrizaçãoo pelo código ou descrição. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: termoBusca description: Código ou descrição da parametrizaçõa. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – parametrizacao properties: parametrizacao: type: array items: type: object allOf: – #/definitions/consultaInformacoesRapida minimum: 1 description: Registros de parametrização retornados contendo o código e a descrição da parametrização. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/consultarFluxoCaixaGeradoRapido: post: description: Permite consultar o fluxo de caixa pelo código ou descrição. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – termoBusca properties: termoBusca: type: string description: Código ou descrição da parametrização. responses: 200: description: Ok schema: type: object required: – fluxoCaixa properties: fluxoCaixa: type: array items: type: object allOf: – #/definitions/consultaInformacoesRapida minimum: 1 description: Registros básicos do fluxo de caixa. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Permite consultar o fluxo de caixa pelo código ou descrição. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: termoBusca description: Código ou descrição da parametrização. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fluxoCaixa properties: fluxoCaixa: type: array items: type: object allOf: – #/definitions/consultaInformacoesRapida minimum: 1 description: Registros básicos do fluxo de caixa. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterInformacoesFluxoCaixa: post: description: Obtém as informações completas de um fluxo de caixa gerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – descricaoFluxo – usuarioGeracao – dataGeracao – parametrizacao properties: descricaoFluxo: type: string description: Descrição do fluxo de caixa usuarioGeracao: type: string description: Usuário que gerou o fluxo usuarioAlteracao: type: string description: Usuário que alterou o fluxo dataGeracao: type: string format: date-time description: Data de geração do fluxo dataAlteracao: type: string format: date-time description: Data de alteração do fluxo descricaoVisao: type: string description: Descrição da visão utilizada dataAtualizacaoIntegracao: type: string format: date-time description: Data da última atualização por integração parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametrização utilizada na geração logsGeracao: type: string description: Logs gerados durante a geração do fluxo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém as informações completas de um fluxo de caixa gerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: Identificador do fluxo de caixa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – descricaoFluxo – usuarioGeracao – dataGeracao – parametrizacao properties: descricaoFluxo: type: string description: Descrição do fluxo de caixa usuarioGeracao: type: string description: Usuário que gerou o fluxo usuarioAlteracao: type: string description: Usuário que alterou o fluxo dataGeracao: type: string format: date-time description: Data de geração do fluxo dataAlteracao: type: string format: date-time description: Data de alteração do fluxo descricaoVisao: type: string description: Descrição da visão utilizada dataAtualizacaoIntegracao: type: string format: date-time description: Data da última atualização por integração parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametrização utilizada na geração logsGeracao: type: string description: Logs gerados durante a geração do fluxo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/incluirBaseHistorica: post: description: Verifica se deve incluir base histórica para as visões informadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visao properties: visao: type: array items: type: string allOf: – #/definitions/tipoVisao minimum: 1 description: Lista de tipos de visão a serem verificados responses: 200: description: Ok schema: type: object required: – incluirBaseHistorica properties: incluirBaseHistorica: type: array items: type: boolean minimum: 1 description: Indica para cada visão se deve incluir base histórica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/incluirTipoDivisao: post: description: Verifica se deve incluir tipo de divisão para a visão informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visao properties: visao: type: string allOf: – #/definitions/tipoVisao description: Tipo de visão a ser verificado responses: 200: description: Ok schema: type: object required: – incluirTipoDivisao properties: incluirTipoDivisao: type: boolean description: Indica se deve incluir tipo de divisão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se deve incluir tipo de divisão para a visão informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: visao description: Tipo de visão a ser verificado in: query required: true type: string allOf: – #/definitions/tipoVisao responses: 200: description: Ok schema: type: object required: – incluirTipoDivisao properties: incluirTipoDivisao: type: boolean description: Indica se deve incluir tipo de divisão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterPercentualRotinas: post: description: Obtém os percentuais das rotinas de um fluxo de caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – percentuais properties: percentuais: type: array items: type: object allOf: – #/definitions/caracteristicaRotina minimum: 1 description: Lista de percentuais por rotina 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os percentuais das rotinas de um fluxo de caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: Identificador do fluxo de caixa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – percentuais properties: percentuais: type: array items: type: object allOf: – #/definitions/caracteristicaRotina minimum: 1 description: Lista de percentuais por rotina 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterLancamentosAgrupamento: post: description: Obtém os lançamentos de um agrupamento do fluxo de caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelAfetado properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelAfetado: type: string description: Nível do agrupamento responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os lançamentos de um agrupamento do fluxo de caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: Identificador do fluxo de caixa in: query required: true type: integer format: int64 – name: nivelAfetado description: Nível do agrupamento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterStatusFluxoCaixa: post: description: Obtém o status atual de um fluxo de caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object allOf: – #/definitions/statusFluxo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o status atual de um fluxo de caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: Identificador do fluxo de caixa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/statusFluxo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterParametrizacoesResumida: post: description: Obtém a lista resumida de parametrizações cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – totalRegistros – parametrizacao properties: totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta parametrizacao: type: array items: type: object allOf: – #/definitions/parametrizacaoResumida minimum: 1 description: Lista de parametrizações resumidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterMovimentoDiversoResumido: post: description: Obtém a lista resumida de movimentos diversos cadastrados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – totalRegistros – movimentoDiverso properties: totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta movimentoDiverso: type: array items: type: object allOf: – #/definitions/movimentoDiversoResumido minimum: 1 description: Lista de movimentos diversos resumidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a lista resumida de movimentos diversos cadastrados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Último nível do período mostrado in: query type: integer format: int64 – name: quantidade description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalRegistros – movimentoDiverso properties: totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta movimentoDiverso: type: array items: type: object allOf: – #/definitions/movimentoDiversoResumido minimum: 1 description: Lista de movimentos diversos resumidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCriterioDistribuicaoResumido: post: description: Obtém a lista resumida de critérios de distribuição de vencidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – totalRegistros – criterioDistribuicao properties: totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta criterioDistribuicao: type: array items: type: object allOf: – #/definitions/criterioDistribuicaoResumido minimum: 1 description: Lista de critérios de distribuição resumidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a lista resumida de critérios de distribuição de vencidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Último nível do período mostrado in: query type: integer format: int64 – name: quantidade description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalRegistros – criterioDistribuicao properties: totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta criterioDistribuicao: type: array items: type: object allOf: – #/definitions/criterioDistribuicaoResumido minimum: 1 description: Lista de critérios de distribuição resumidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterFluxoCaixaGeradoResumido: post: description: Obtém a lista resumida de fluxos de caixa gerados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: fluxoId: type: integer format: int64 description: Filtrar resumo por fluxo gerado offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – totalRegistros – fluxoResumido properties: totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta fluxoResumido: type: array items: type: object allOf: – #/definitions/fluxoResumido minimum: 1 description: Lista de fluxos de caixa resumidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterPeriodoFluxo: post: description: Obtém os períodos e linhas de um fluxo de caixa gerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idFluxo – offset – quantidade properties: idFluxo: type: integer format: int64 description: Identificador do fluxo de caixa offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – periodos – linhasFluxo – totalRegistros properties: periodos: type: object allOf: – #/definitions/periodo description: Períodos do fluxo de caixa linhasFluxo: type: array items: type: object allOf: – #/definitions/linhaFluxo minimum: 1 description: Linhas do fluxo de caixa caixaMinimo: type: string description: Valor do caixa mínimo configurado limiteCredito: type: string description: Valor do limite de crédito configurado totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os períodos e linhas de um fluxo de caixa gerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idFluxo description: Identificador do fluxo de caixa in: query required: true type: integer format: int64 – name: offset description: Último nível do período mostrado in: query required: true type: integer format: int64 – name: quantidade description: Quantidade de itens a ser retornada in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – periodos – linhasFluxo – totalRegistros properties: periodos: type: object allOf: – #/definitions/periodo description: Períodos do fluxo de caixa linhasFluxo: type: array items: type: object allOf: – #/definitions/linhaFluxo minimum: 1 description: Linhas do fluxo de caixa caixaMinimo: type: string description: Valor do caixa mínimo configurado limiteCredito: type: string description: Valor do limite de crédito configurado totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/compararFluxoCaixa: post: description: Retorna a comparação entre um fluxo base e outros fluxos de caixas zerados.\nPara comparar, os fluxos envolvidos devem ter a mesma periodicidade e mesmo agrupador.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoIdBase – fluxoComparacao properties: fluxoIdBase: type: integer format: int64 description: Identificador do fluxo base fluxoComparacao: type: array items: type: integer format: int64 minimum: 1 description: Identificador dos fluxos a serem comaparados. Devem ser informado ao menos um fluxo offset: type: integer format: int64 description: Número do período a partir do qual devem ser retornados dados de comparação quantidade: type: integer format: int64 description: Quantidade de períodos que devem ser retornados pelo serviço. Cada período traz todos cenários envolvidos. fuso: type: integer format: int64 description: Fuso horario do usuário responses: 200: description: Ok schema: type: object required: – periodos – linhasFluxo – totalRegistros properties: periodos: type: object allOf: – #/definitions/periodo description: Os períodos da comparação linhasFluxo: type: array items: type: object allOf: – #/definitions/linhaFluxo minimum: 1 description: Linhas da comparação totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheTituloReceber: post: description: Retorna os detalhes dos títulos a receber de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a receber\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheTituloReceber minimum: 1 description: Lista com os títulos a receber totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalhePedido: post: description: Retorna os detalhes das parcelas de pedido de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a receber\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalhePedido minimum: 1 description: Lista com as parcelas de pedido totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheContratoVenda: post: description: Retorna os detalhes das parcelas de contratos de venda de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a receber\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheContratoVenda minimum: 1 description: Lista com as parcelas de contratos de venda totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheOrdemCompra: post: description: Retorna os detalhes das parcelas de ordens de compra de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a receber\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheOrdemCompra minimum: 1 description: Lista com as parcelas de ordens de compra totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheContratoCompra: post: description: Retorna os detalhes das parcelas de contratos de compra de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a receber\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheContratoCompra minimum: 1 description: Lista com as parcelas de contratos de compra totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheTituloPagar: post: description: Retorna os detalhes dos títulos a pagar de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheTituloPagar minimum: 1 description: Lista com os títulos a pagar totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheMovimentoDiverso: post: description: Retorna os detalhes dos movimentos diversos de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheMovimentoDiverso minimum: 1 description: Lista com os movimentos diversos totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheComissao: post: description: Retorna os detalhes das comissões de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheComissao minimum: 1 description: Lista com as comissões totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheServicoPontoVenda: post: description: Retorna os detalhes dos serviços de ponto de venda de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheServicoPontoVenda minimum: 1 description: Lista com os serviços de ponto de venda totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheAplicacaoFinanceira: post: description: Retorna os detalhes dos movimentos de aplicação financeira de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheAplicacaoFinanceira minimum: 1 description: Lista com os movimentos de aplicação financeira totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheEmprestimos: post: description: Retorna os detalhes dos títulos de empréstimo de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheEmprestimos minimum: 1 description: Lista com os títulos de empréstimo totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheTesouraria: post: description: Retorna os detalhes dos movimentos da tesouraria de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheTesouraria minimum: 1 description: Lista com os movimentos da tesouraria totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheExtratoBancario: post: description: Retorna os detalhes dos serviços de ponto de venda de um item de período do Fluxo de Caixa\n[in] fluxoId: identificador do fluxo\n[in] nivel: localização linha x coluna do item de período do fluxo (célula)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] camposOrdenacao: lista de campos para ordenação dos dados\n[out] detalhes: Retorna uma lista com os títulos a pagar\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheExtratoBancario minimum: 1 description: Lista com os extratos bancários totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterAgrupamentosFilial: post: description: Retorna os agrupamentos cadastros\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] – agrupamentosFilial: Retorna uma lista de agrupamentos\nDeverá retornar ordenados por:\nagrupamentofilial.empresa_id, agrupamentofilial.agrupamento\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – agrupamentosFilial – totalRegistros properties: agrupamentosFilial: type: array items: type: object allOf: – #/definitions/agrupamentoFilial minimum: 1 description: Lista de agrupamentos de filiais totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterFiliaisEmpresa: post: description: Retorna as filias por empresa\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] – filial: Retorna uma lista de filiais\nDeverá retornar ordenados por:\nfilial.empresa_id, filial.filial\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Lista de filiais totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterFiliaisAgrupamento: post: description: Retorna as filias por agrupamento\n[in] agrupamentoId: recebe os códigos dos agrupamentos selecionados\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] – filial: Retorna uma lista de filiais\nDeverá retornar ordenados por:\nfilial.empresa_id, filial.filial\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: agrupamentoId: type: array items: type: integer format: int64 description: Códigos dos agrupamentos selecionados offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: Lista de filiais totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/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 (ordenada pelo id).\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] – listaEmpresas: Retorna uma lista de empresas\nDeverá retornar ordenados por:\nempresa.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaEmpresas – totalRegistros properties: listaEmpresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Lista de empresas totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials 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 (ordenada pelo id).\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] – listaEmpresas: Retorna uma lista de empresas\nDeverá retornar ordenados por:\nempresa.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Item a partir do qual os resultados devem ser montados in: query type: integer format: int64 – name: quantidade description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaEmpresas – totalRegistros properties: listaEmpresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: Lista de empresas totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTipoTitulo: post: description: Retorna uma lista com os tipos de títulos por tipo de aplicabilidade\n[in] aplicacao: filtro por tipo de aplicabilidade do tipo de título\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaTipoTitulos: retorna uma lista com os tipos de títulos carregados\nDeverá retornar ordenados por:\ntipotitulo.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – aplicacao properties: aplicacao: type: array items: type: string allOf: – #/definitions/aplicacaoFinanceiro minimum: 1 description: Filtro por tipo de aplicabilidade do tipo de título offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTipoTitulos – totalRegistros properties: listaTipoTitulos: type: array items: type: object allOf: – #/definitions/tipoTitulo minimum: 1 description: Lista com os tipos de títulos totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoContasReceber: post: description: Retorna as transações de contas a receber filtradas por empresa, visão e categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoVisao properties: empresaId: type: array items: type: integer format: int64 description: lista de empresas a serem filtradas para busca das transações tipoVisao: type: string allOf: – #/definitions/tipoVisao description: visão do fluxo de caixa categoria: type: string allOf: – #/definitions/categoriaTitulos description: categoria da filtragem transacaoEntrada: type: boolean description: utilizado somente para visão realizado offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoContasPagar: post: description: Retorna as transações de contas a pagar filtradas por empresa, visão e categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoVisao properties: empresaId: type: array items: type: integer format: int64 description: lista de empresas a serem filtradas para busca das transações tipoVisao: type: string allOf: – #/definitions/tipoVisao description: visão do fluxo de caixa categoria: type: string allOf: – #/definitions/categoriaTitulos description: categoria da filtragem transacaoEntrada: type: boolean description: utilizado somente para visão realizado offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoPedidos: post: description: Retorna as transações de pedidos de venda filtradas por empresa 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: lista de empresas a serem filtradas para busca das transações offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoContratosVenda: post: description: Retorna as transações de contratos de venda filtradas por empresa e módulo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modulo properties: empresaId: type: array items: type: integer format: int64 description: lista de empresas a serem filtradas para busca das transações modulo: type: array items: type: string allOf: – #/definitions/modulosTransacao minimum: 1 description: modulos a serem passados (VEF, VES) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoContratosCompra: post: description: Retorna as transações de contratos de compra filtradas por empresa e módulo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modulo properties: empresaId: type: array items: type: integer format: int64 description: lista de empresas a serem filtradas para busca das transações modulo: type: array items: type: string allOf: – #/definitions/modulosTransacao minimum: 1 description: modulos a serem passados (COF, COS) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoOrdensCompra: post: description: Retorna as transações de ordens de compra filtradas por empresa 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: lista de empresas a serem filtradas para busca das transações offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoTesouraria: post: description: Retorna as transações de tesouraria filtradas por empresa e natureza tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – natureza properties: empresaId: type: array items: type: integer format: int64 description: lista de empresas a serem filtradas para busca das transações natureza: type: string allOf: – #/definitions/naturezaMovimento description: indicativo da natureza da transação, para retornar somente transações de C-Crédito ou D-Débito offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoComissao: post: description: Retorna as transações de comissão filtradas por empresa 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: lista de empresas a serem filtradas para busca das transações offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTransacoes – totalRegistros properties: listaTransacoes: type: array items: type: object allOf: – #/definitions/transacao minimum: 1 description: Retorna uma lista com as transações totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterGrupoContas: post: description: Retorna uma lista com os grupos de conta por tipo de aplicabilidade\n[in] aplicacao: filtro por tipo de aplicabilidade do grupo de conta\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaGrupoContas: retorna uma lista com os grupos de contas carregados\nDeverá retornar ordenados por:\ngrupoconta.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – aplicacao properties: aplicacao: type: array items: type: string allOf: – #/definitions/aplicacaoFinanceiro minimum: 1 description: Filtro por tipo de aplicabilidade do grupo de conta offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaGrupoContas – totalRegistros properties: listaGrupoContas: type: array items: type: object allOf: – #/definitions/grupoContas minimum: 1 description: Lista com os grupos de contas totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCondicaoPagamento: post: description: Retorna uma lista com as condições de pagamento\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[in] aplicacao: Quais condições devem ser retornada, com aplicação igual a Ambos, Compras ou Vendas\n[out] listaCondicaoPagamento: retorna a lista com as condições de pagamento\nDeverá retornar ordenados por:\ncondicaopagamento.empresa_id, condicaopagamento.condicao\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – aplicacao properties: empresaId: type: array items: type: integer format: int64 description: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada aplicacao: type: array items: type: string allOf: – #/definitions/aplicacaoMercadoSuprimentos minimum: 1 description: Filtro por aplicação (Ambos, Compras ou Vendas) responses: 200: description: Ok schema: type: object required: – listaCondicaoPagamento – totalRegistros properties: listaCondicaoPagamento: type: array items: type: object allOf: – #/definitions/condicaoPagamento minimum: 1 description: Lista com as condições de pagamento totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterFormaPagamento: post: description: Retorna uma lista com as formas de pagamento\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaFormaPagamento: retorna a lista com as formas de pagamento\nDeverá retornar ordenados por:\nformapagamento.empresa_id, formapagamento.forma_pagamento\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaFormaPagamento – totalRegistros properties: listaFormaPagamento: type: array items: type: object allOf: – #/definitions/formaPagamento minimum: 1 description: Lista com as formas de pagamento totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterPortador: post: description: Retorna uma lista com os portadores\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaPortador: retorna a lista com os portadores\nDeverá retornar ordenados por:\nportador.empresa_id, portador.portador\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaPortador – totalRegistros properties: listaPortador: type: array items: type: object allOf: – #/definitions/portador minimum: 1 description: Lista com os portadores totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCarteira: post: description: Retorna uma lista com os portadores\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaCarteira: retorna a lista com as carteiras\nDeverá retornar ordenados por:\ncarteira.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaCarteira – totalRegistros properties: listaCarteira: type: array items: type: object allOf: – #/definitions/carteira minimum: 1 description: Lista com as carteiras totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com os portadores\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaCarteira: retorna a lista com as carteiras\nDeverá retornar ordenados por:\ncarteira.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Item a partir do qual os resultados devem ser montados in: query type: integer format: int64 – name: quantidade description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaCarteira – totalRegistros properties: listaCarteira: type: array items: type: object allOf: – #/definitions/carteira minimum: 1 description: Lista com as carteiras totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterNaturezaGastos: post: description: Retorna uma lista com as naturezas de gastos\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaNaturezaGastos: retorna a lista com as naturezas de gastos\nDeverá retornar ordenados por:\nnaturezagasto.empresa_id, naturezagasto.natureza_gasto\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada tipoNaturezaGastos: type: array items: type: string allOf: – #/definitions/tipoNaturezaGastos description: Filtro por tipo de natureza de gastos responses: 200: description: Ok schema: type: object required: – listaNaturezaGastos – totalRegistros properties: listaNaturezaGastos: type: array items: type: object allOf: – #/definitions/naturezaGastos minimum: 1 description: Lista com as naturezas de gastos totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterMoeda: post: description: Retorna uma lista com as moedas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaMoeda: retorna a lista com as moedas\nDeverá retornar ordenados por:\nmoeda.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaMoeda – totalRegistros properties: listaMoeda: type: array items: type: object allOf: – #/definitions/moeda minimum: 1 description: Lista com as moedas totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com as moedas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaMoeda: retorna a lista com as moedas\nDeverá retornar ordenados por:\nmoeda.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Item a partir do qual os resultados devem ser montados in: query type: integer format: int64 – name: quantidade description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaMoeda – totalRegistros properties: listaMoeda: type: array items: type: object allOf: – #/definitions/moeda minimum: 1 description: Lista com as moedas totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterMoedaSaida: post: description: Retorna uma lista com as moedas que são diferentes das cadastradas nas empresas\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaMoeda: retorna a lista com as moedas\nDeverá retornar ordenados por:\nmoeda.id\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaMoeda – totalRegistros properties: listaMoeda: type: array items: type: object allOf: – #/definitions/moeda minimum: 1 description: Lista com as moedas de saída totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCotacaoMoeda: post: description: Retorna a cotacao da data base da moeda\n[in] moedaId: identificador da moeda selecionada pelo fluxo de caixa\n[in] dataBase: data base para busca da cotacao (DD/MM/YYYY)\n[out] cotacao: valor da cotacao retornada da data base;\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – moedaId – dataBase properties: moedaId: type: string description: Identificador da moeda selecionada dataBase: type: string format: date description: Data base para busca da cotação (DD/MM/YYYY) responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: Valor da cotação retornada da data base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a cotacao da data base da moeda\n[in] moedaId: identificador da moeda selecionada pelo fluxo de caixa\n[in] dataBase: data base para busca da cotacao (DD/MM/YYYY)\n[out] cotacao: valor da cotacao retornada da data base;\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: moedaId description: Identificador da moeda selecionada in: query required: true type: string – name: dataBase description: Data base para busca da cotação (DD/MM/YYYY) in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: Valor da cotação retornada da data base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTipoConta: post: description: Retorna os tipos de contas internas disponíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tipoConta: type: array items: type: string description: Define quais contas internas devem ser retornadas aplicacao: type: array items: type: integer format: int64 description: Filtro por tipo de aplicação offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – totalRegistros properties: listaTipoConta: type: array items: type: object allOf: – #/definitions/tipoConta description: retorna os tipos de contas internas pesquisadas totalRegistros: type: integer format: int64 description: quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterContaInterna: post: description: Retorna uma lista com as contas internas\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] tipoConta: filtro por tipo de conta (abrangente e opcional)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaContaInterna: retorna a lista com as contas internas\nDeverá retornar ordenados por:\ncontainterna.empresa_id, containterna.conta_interna\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas tipoContaId: type: array items: type: string description: Filtro por tipo de conta aplicacaoContaInterna: type: array items: type: integer format: int64 description: Filtro por aplicação da conta interna offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaContaInterna – totalRegistros properties: listaContaInterna: type: array items: type: object allOf: – #/definitions/contaInterna minimum: 1 description: Lista com as contas internas totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterMotivo: post: description: Retorna uma lista com os motivos\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaMotivo: retorna a lista com os motivos\nDeverá retornar ordenados por:\nmotivo.id\n[out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: aplicacaoMotivo: type: array items: type: integer format: int64 description: Filtro por aplicação do motivo offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaMotivo – totalRegistros properties: listaMotivo: type: array items: type: object allOf: – #/definitions/motivo minimum: 1 description: Lista com os motivos totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTipoDocumento: post: description: Retorna uma lista com os tipos de documentos\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaTipoDocumento: retorna a lista com os tipos de documentos\nDeverá retornar ordenados por:\ntipodocumento.empresa_id, tipodocumento.documento\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaTipoDocumento – totalRegistros properties: listaTipoDocumento: type: array items: type: object allOf: – #/definitions/tipoDocumento minimum: 1 description: Lista com os tipos de documentos totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterProjeto: post: description: Retorna uma lista com os projetos\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaProjetos: retorna a lista com os projetos\nDeverá retornar ordenados por:\nprojeto.empresa_id, projeto.projeto\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada naturezaProjeto: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: Filtro por natureza do projeto responses: 200: description: Ok schema: type: object required: – listaProjetos – totalRegistros properties: listaProjetos: type: array items: type: object allOf: – #/definitions/projeto minimum: 1 description: Lista com os projetos totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterFaseProjeto: post: description: Retorna uma lista com as fases dos projetos\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] projeto: filtro por projeto (abrangente e obrigatório)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaFaseProjetos: retorna a lista com as fases/projetos\nDeverá retornar ordenados por:\nfaseprojeto.empresa_id, faseprojeto.projeto_id, faseprojeto.fase\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas projetoId: type: array items: type: integer format: int64 description: Filtro por projeto offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada naturezaFase: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: Filtro por natureza da fase responses: 200: description: Ok schema: type: object required: – listaFaseProjetos – totalRegistros properties: listaFaseProjetos: type: array items: type: object allOf: – #/definitions/faseProjeto minimum: 1 description: Lista com as fases dos projetos totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterContaFinanceira: post: description: Retorna uma lista com as contas financeiras\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaContaFinanceira: retorna a lista com as contas financeiras\nDeverá retornar ordenados por:\ncontafinanceira.empresa_id, contafinanceira.conta_financeira\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada naturezaContaFinanceira: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: Filtro por natureza da conta financeira tipoTotaisContas: type: string allOf: – #/definitions/tipoTotaisContas description: Filtro por tipo de totais de contas responses: 200: description: Ok schema: type: object required: – listaContaFinanceira – totalRegistros properties: listaContaFinanceira: type: array items: type: object allOf: – #/definitions/contaFinanceira minimum: 1 description: Lista com as contas financeiras totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterContaContabil: post: description: Retorna uma lista com as contas contabéis\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaContaContabil: retorna a lista com as contas contabéis\nDeverá retornar ordenados por:\ncontacontabil.empresa_id, contacontabil.conta_contabil\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada naturezaContaContabil: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: Filtro por natureza da conta contábil tipoTotaisContas: type: string allOf: – #/definitions/tipoTotaisContas description: Filtro por tipo de totais de contas responses: 200: description: Ok schema: type: object required: – listaContaContabil – totalRegistros properties: listaContaContabil: type: array items: type: object allOf: – #/definitions/contaContabil minimum: 1 description: Lista com as contas contábeis totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCentroCusto: post: description: Retorna uma lista com os centro de custos\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaCentroCusto: retorna a lista com os centro de custos\nDeverá retornar ordenados por:\ncentrocusto.empresa_id, centrocusto.centro_custo\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada tipoTotaisContas: type: string allOf: – #/definitions/tipoTotaisContas description: Filtro por tipo de totais de contas responses: 200: description: Ok schema: type: object required: – listaCentroCusto – totalRegistros properties: listaCentroCusto: type: array items: type: object allOf: – #/definitions/centroCusto minimum: 1 description: Lista com os centros de custo totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterAssessoriaCobranca: post: description: Retorna uma lista com as assessorias de cobrança\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaAssessoriaCobranca: retorna a lista com as assessorias de cobrança\nDeverá retornar ordenados por:\nassessoriacobranca.empresa_id, assessoriacobranca.assessoria\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaAssessoriaCobranca – totalRegistros properties: listaAssessoriaCobranca: type: array items: type: object allOf: – #/definitions/assessoriaCobranca minimum: 1 description: Lista com as assessorias de cobrança totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterFasesCobranca: post: description: Retorna uma lista com as fases de cobrança\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaAssessoriaCobranca: retorna a lista com as fases de cobrança\nDeverá retornar ordenados por:\nfasecobranca.empresa_id, fasecobranca.assessoria_id, fasecobranca.fase\n 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: Códigos das empresas selecionadas assessoriaId: type: array items: type: integer format: int64 description: Filtro por assessoria de cobrança offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaFaseCobranca – totalRegistros properties: listaFaseCobranca: type: array items: type: object allOf: – #/definitions/faseCobranca minimum: 1 description: Lista com as fases de cobrança totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterProdutoBancario: post: description: Retorna uma lista com os produtos bancários\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] tipoProduto: tipo do produto bancário (abrangente e opcional)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaProdutoBancario: retorna a lista com os produtos bancários\nDeverá retornar ordenados por:\nprodutobancario.empresa_id, produtobancario.numero\n 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: Códigos das empresas selecionadas tipoOperacao: type: integer format: int64 description: Filtro por tipo de operação offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaProdutoBancario properties: listaProdutoBancario: type: array items: type: object allOf: – #/definitions/produtoBancario minimum: 1 description: Lista com os produtos bancários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCalculoContratoFinanceiro: post: description: Retorna uma lista com os cálculos de contratos de aplicação/empréstimos\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaCalculoContratoFinanceiro: retorna a lista com os cálculos de contratos de aplicação/empréstimos\nDeverá retornar ordenados por:\ncalculocontratofin.empresa_id, calculocontratofin.numero\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaCalculoContratoFinanceiro – totalRegistros properties: listaCalculoContratoFinanceiro: type: array items: type: object allOf: – #/definitions/calculoContratoFinanceiro minimum: 1 description: Lista com os cálculos de contratos financeiros totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCorrespondenteBancario: post: description: Retorna uma lista com os correspondentes bancários\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaCorrespondenteBancario: retorna a lista com os correspondentes bancários\nDeverá retornar ordenados por:\nbanco.id (somente retornar bancos onde o campos correspondete estiver igual a S\n[out] totalRegistros: Quantidade total de registros da consulta 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaCorrespondenteBancario – totalRegistros properties: listaCorrespondenteBancario: type: array items: type: object allOf: – #/definitions/banco minimum: 1 description: Lista com os correspondentes bancários totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterProdutoCorrespondenteBancario: post: description: Retorna uma lista com os produtos dos correspondentes bancários\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] correspondente: filtro por correspondente bancário (abrangente e opcional)\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaProdutoCorrespondenteBancario: retorna a lista com os produtos dos correspondentes bancários\nDeverá retornar ordenados por:\nprodutocorrespondenteban.empresa_id, produtocorrespondenteban.banco_id, produtocorrespondenteban.produto\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas correspondenteId: type: array items: type: string description: Filtro por correspondente bancário offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaProdutoCorrespondenteBancario – totalRegistros properties: listaProdutoCorrespondenteBancario: type: array items: type: object allOf: – #/definitions/produtoCorrespondenteBancario minimum: 1 description: Lista com os produtos dos correspondentes bancários totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterOperadorTelefonia: post: description: Retorna uma lista com as operadoras de telefonia\n[in] empresaId: recebe os códigos das empresas selecionadas\n[in] offset: Item a partir do qual os resultados devem ser montados\n[in] quantidade: Quantidade de itens a ser retornada\n[out] listaOperadorTelefonia: retorna a lista com as operadoras de telefonia\nDeverá retornar ordenados por:\noperadortelefonia.empresa_id, operadortelefonia.operadora\n[out] totalRegistros: Quantidade total de registros da consulta\n 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: Códigos das empresas selecionadas offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaOperadorTelefonia – totalRegistros properties: listaOperadorTelefonia: type: array items: type: object allOf: – #/definitions/operadorTelefonia minimum: 1 description: Lista com as operadoras de telefonia totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDiaUtil: post: description: Calcula o dia útil para uma lista de datas informadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – listaDatas properties: listaDatas: type: array items: type: object allOf: – #/definitions/diaUtil minimum: 1 description: Recebe uma lista com o nome do campo a ser calculado a data do seu dia útil responses: 200: description: Ok schema: type: object required: – listaRetorno properties: listaRetorno: type: array items: type: object allOf: – #/definitions/diaUtil minimum: 1 description: Retorna uma lista com o nome do campo e a data do seu dia útil que foi calculado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDatasCalculadasTitulosReceber: post: description: Calcula as datas em dias úteis para títulos a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: array items: type: object allOf: – #/definitions/tituloReceberInicializacao minimum: 1 description: recebe os títulos a receber que serão calculados suas datas em dias uteis responses: 200: description: Ok schema: type: object required: – datas properties: datas: type: array items: type: object allOf: – #/definitions/datasCalculadasReceber minimum: 1 description: devolve as datas calculadas por título a receber 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDatasCalculadasTitulosPagar: post: description: Calcula as datas em dias úteis para títulos a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: array items: type: object allOf: – #/definitions/tituloPagarInicializacao minimum: 1 description: recebe os títulos a receber que serão calculados suas datas em dias uteis responses: 200: description: Ok schema: type: object required: – datas properties: datas: type: array items: type: object allOf: – #/definitions/datasCalculadasPagar minimum: 1 description: devolve as datas calculadas por título a receber 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDataPeriodo: post: description: Calcula o período inicial e final a partir de um critério de busca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoBusca properties: tipoBusca: type: string allOf: – #/definitions/periodoFluxo description: recebe o tipo de busca para cálculo do período dataPeriodo: type: string format: date description: data do período, caso informado, o retorno será baseado nessa data, caso contrário, será sempre sobre a data atual do servidor responses: 200: description: Ok schema: type: object required: – periodoInicial – periodoFinal properties: periodoInicial: type: string format: date description: Período inicial calculado a partir do critério de busca periodoFinal: type: string format: date description: Período final calculado a partir do critério de busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Calcula o período inicial e final a partir de um critério de busca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tipoBusca description: recebe o tipo de busca para cálculo do período in: query required: true type: string allOf: – #/definitions/periodoFluxo – name: dataPeriodo description: data do período, caso informado, o retorno será baseado nessa data, caso contrário, será sempre sobre a data atual do servidor in: query type: string format: date responses: 200: description: Ok schema: type: object required: – periodoInicial – periodoFinal properties: periodoInicial: type: string format: date description: Período inicial calculado a partir do critério de busca periodoFinal: type: string format: date description: Período final calculado a partir do critério de busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterSituacoesTitulo: post: description: Retorna as situações de título disponíveis para a visão e rotina informadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visao – rotina properties: visao: type: string allOf: – #/definitions/tipoVisao description: tipo visão do fluxo rotina: type: string allOf: – #/definitions/rotinaFluxo description: Contas a Pagar ou Contas a Receber offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – situacoes – totalRegistros properties: situacoes: type: array items: type: object allOf: – #/definitions/situacaoTitulo minimum: 1 description: Lista de situações de título totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as situações de título disponíveis para a visão e rotina informadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: visao description: tipo visão do fluxo in: query required: true type: string allOf: – #/definitions/tipoVisao – name: rotina description: Contas a Pagar ou Contas a Receber in: query required: true type: string allOf: – #/definitions/rotinaFluxo – name: offset description: Último nível do período mostrado in: query type: integer format: int64 – name: quantidade description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – situacoes – totalRegistros properties: situacoes: type: array items: type: object allOf: – #/definitions/situacaoTitulo minimum: 1 description: Lista de situações de título totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterSaldoAnteriorContasInternas: post: description: Obtém o saldo anterior das contas internas para uma data específica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data – tipoData properties: empresaId: type: array items: type: integer format: int64 description: Lista de identificadores de empresas filialId: type: array items: type: integer format: int64 description: Lista de identificadores de filiais data: type: string format: date description: Data de referência para o saldo tipoData: type: string allOf: – #/definitions/tipoDataSaldo description: Tipo de data para busca do saldo contaInternaId: type: array items: type: integer format: int64 description: Lista de identificadores de contas internas tipoContaId: type: array items: type: string description: Lista de identificadores de tipos de conta responses: 200: description: Ok schema: type: object required: – saldo properties: saldo: type: string description: Valor do saldo anterior 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterSaldoAnteriorExtratosBancarios: post: description: Obtém o saldo anterior dos extratos bancários para uma data específica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: empresaId: type: array items: type: integer format: int64 description: Lista de identificadores de empresas data: type: string format: date description: Data de referência para o saldo contaInternaId: type: array items: type: integer format: int64 description: Lista de identificadores de contas internas tipoContaId: type: array items: type: string description: Lista de identificadores de tipos de conta filtroExtrato: type: string allOf: – #/definitions/filtroExtratos description: Filtro de extratos bancários responses: 200: description: Ok schema: type: object required: – saldo properties: saldo: type: string description: Valor do saldo anterior 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/consistirEmpresasGeracaoFluxo: post: description: Valida as empresas selecionadas para geração do fluxo de caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresasId: type: array items: type: integer format: int64 description: Lista de identificadores de empresas a serem validadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTemplatePercentualResumido: post: description: Obtém a lista resumida de templates de percentual cadastrados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada periodicidade: type: array items: type: string allOf: – #/definitions/periodicidade description: Filtro por periodicidade agrupamento: type: array items: type: string allOf: – #/definitions/agrupamento description: Filtro por agrupamento camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – totalRegistros – templateResumido properties: totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta templateResumido: type: array items: type: object allOf: – #/definitions/templatePercentualResumido minimum: 1 description: Lista de templates de percentual resumidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/compararFluxoPrevistoRealizadoBot: post: description: Compara dois fluxos de caixa, um previsto ou realizado, com objetivo de fornecer dados através de chatbot tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: data: type: string format: date description: Data para comparação. Quando não informado, considera a data atual responses: 200: description: Ok schema: type: object required: – data – previsto – realizado properties: data: type: string format: date description: Data da comparação previsto: type: object allOf: – #/definitions/dadosComparacaoFluxo description: Dados referentes ao fluxo previsto realizado: type: object allOf: – #/definitions/dadosComparacaoFluxo description: Dados referentes ao fluxo realizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Compara dois fluxos de caixa, um previsto ou realizado, com objetivo de fornecer dados através de chatbot tags: – Queries x-senior-visibility: PRIVATE parameters: – name: data description: Data para comparação. Quando não informado, considera a data atual in: query type: string format: date responses: 200: description: Ok schema: type: object required: – data – previsto – realizado properties: data: type: string format: date description: Data da comparação previsto: type: object allOf: – #/definitions/dadosComparacaoFluxo description: Dados referentes ao fluxo previsto realizado: type: object allOf: – #/definitions/dadosComparacaoFluxo description: Dados referentes ao fluxo realizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/calcularTendenciaRealizacaoCenarioPrevisaoBot: post: description: Calcula a tendência de realização do cenário de previsão para uso em chatbot tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: data: type: string format: date description: Data para comparação. Quando não informado, considera a data atual responses: 200: description: Ok schema: type: object required: – valorPrevisto properties: valorPrevisto: type: string description: Valor previsto para o período diferencaRealizacao: type: number format: double description: Diferença percentual entre previsto e realizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Calcula a tendência de realização do cenário de previsão para uso em chatbot tags: – Queries x-senior-visibility: PRIVATE parameters: – name: data description: Data para comparação. Quando não informado, considera a data atual in: query type: string format: date responses: 200: description: Ok schema: type: object required: – valorPrevisto properties: valorPrevisto: type: string description: Valor previsto para o período diferencaRealizacao: type: number format: double description: Diferença percentual entre previsto e realizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasReceberRealizado: post: description: Realiza a montagem do cenário das contas a receber – realizado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasReceberRealizadoEntradaTitulosEfetivos: post: description: Realiza a montagem do cenário das contas a receber – realizado pela entrada titulos efetivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasReceber: post: description: Realiza a montagem do cenário das contas a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasPagarRealizado: post: description: Realiza a montagem do cenário das contas a pagar – realizado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasPagarRealizadoEntradaTitulosEfetivos: post: description: Realiza a montagem do cenário das contas a pagar – realizado pela entrada titulos efetivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasPagar: post: description: Realiza a montagem do cenário das contas a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioTesouraria: post: description: Realiza a montagem do cenário da tesouraria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – receita – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem receita: type: boolean description: Indica se é Receita fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioExtratoBancario: post: description: Realiza a montagem do cenário do extrato bancário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – receita – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem receita: type: boolean description: Indica se é Receita fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContratoVenda: post: description: Realiza a montagem do cenário do contrato de venda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContratoCompra: post: description: Realiza a montagem do cenário do contrato de compra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioEmprestimo: post: description: Realiza a montagem do cenário do emprestimo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioAplicacaoFinanceira: post: description: Realiza a montagem do cenário da aplicação financeira tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioServicoPontoVenda: post: description: Realiza a montagem do cenário do serviço de ponto de venda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioOrdemCompra: post: description: Realiza a montagem do cenário da ordem de compra tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioPedido: post: description: Realiza a montagem do cenário do pedido tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioComissao: post: description: Realiza a montagem do cenário da comissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – relizaSimulacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem relizaSimulacao: type: boolean description: Indica se é para realizar simulação fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioMovimentoDiversos: post: description: Realiza a montagem do cenário dos movimentos diversos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – receita – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem receita: type: boolean description: Indica se é Receita fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioDistribuicaoVencidosReceber: post: description: Realiza a montagem do cenário da distribuição de vencidos a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioDistribuicaoVencidosPagar: post: description: Realiza a montagem do cenário da distribuição de vencidos a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioOrcamento: post: description: Realiza a montagem do cenário do orçamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – receita – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem receita: type: boolean description: Indica se é Receita fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioBaseHistorica: post: description: Realiza a montagem do cenário da base histórica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – receita – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem receita: type: boolean description: Indica se é Receita fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioOrcamentariaReceita: post: description: Realiza a montagem do cenário de receita dos Orçamentos GOF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioOrcamentariaDespesa: post: description: Realiza a montagem do cenário de despesa dos Orçamentos GOF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasReceberPrevistoCongelado: post: description: Realiza a montagem do cenário das contas a receber – previsto congelado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/gerarCenarioContasPagarPrevistoCongelado: post: description: Realiza a montagem do cenário das contas a pagar – previsto congelado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacao – fluxoCaixaId properties: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametros utilizados para a montagem fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Retorna se ouve sucesso na geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/utilizaRotinaOrcGof: post: description: Retorna se é utilizado a rotina orc-gof do SeniorX tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – utilizaOrcGof properties: utilizaOrcGof: type: boolean description: Retorna se é utilizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se é utilizado a rotina orc-gof do SeniorX tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – utilizaOrcGof properties: utilizaOrcGof: type: boolean description: Retorna se é utilizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/calculaVisaoProjetadaPorMedia: post: description: Retorna se é utilizado o cálculo de visão projetada por média tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – calculaVisaoProjetadaPorMedia properties: calculaVisaoProjetadaPorMedia: type: boolean description: Retorna se é utilizado o cálculo de visão projetada por média 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna se é utilizado o cálculo de visão projetada por média tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – calculaVisaoProjetadaPorMedia properties: calculaVisaoProjetadaPorMedia: type: boolean description: Retorna se é utilizado o cálculo de visão projetada por média 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheOrcamentariaReceita: post: description: Retorna os detalhes dos orçamentos de receita de um item de período do Fluxo de Caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheOrcamentaria minimum: 1 description: Retorna uma lista com os detalhes da orçamentaria totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDetalheOrcamentariaDespesa: post: description: Retorna os detalhes dos orçamentos de despesa de um item de período do Fluxo de Caixa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel properties: fluxoId: type: integer format: int64 description: Identificador do fluxo nivel: type: string description: Localização linha x coluna do item de período do fluxo (célula) offset: type: integer format: int64 description: Item a partir do qual os resultados devem ser montados quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Lista de campos para ordenação dos dados responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheOrcamentaria minimum: 1 description: Retorna uma lista com os detalhes da orçamentaria totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/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 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: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/retrieveMovimentoDiverso: post: description: Recupera um movimento diverso pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do movimento diverso responses: 200: description: Ok schema: type: object required: – movimentoDiverso properties: movimentoDiverso: type: object allOf: – #/definitions/recMovimentoDiverso description: Movimento diverso encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera um movimento diverso pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do movimento diverso in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – movimentoDiverso properties: movimentoDiverso: type: object allOf: – #/definitions/recMovimentoDiverso description: Movimento diverso encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/listMovimentoDiverso: post: description: Lista os movimentos diversos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Offset para paginação size: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recMovimentoDiverso minimum: 1 description: Lista de movimentos diversos totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os movimentos diversos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Offset para paginação in: query type: integer format: int64 – name: size description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recMovimentoDiverso minimum: 1 description: Lista de movimentos diversos totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/retrieveCriterioDistribuicaoVencidos: post: description: Recupera um critério de distribuição de vencidos pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do critério responses: 200: description: Ok schema: type: object required: – criterioDistribuicaoVencidos properties: criterioDistribuicaoVencidos: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos description: Critério encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera um critério de distribuição de vencidos pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do critério in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – criterioDistribuicaoVencidos properties: criterioDistribuicaoVencidos: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos description: Critério encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/listCriterioDistribuicaoVencidos: post: description: Lista os critérios de distribuição de vencidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Offset para paginação size: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos minimum: 1 description: Lista de critérios totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os critérios de distribuição de vencidos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Offset para paginação in: query type: integer format: int64 – name: size description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos minimum: 1 description: Lista de critérios totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/retrieveLancamentoSimulacao: post: description: Recupera um lançamento de simulação pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do lançamento responses: 200: description: Ok schema: type: object required: – lancamentoSimulacao properties: lancamentoSimulacao: type: object allOf: – #/definitions/recLancamentoSimulacao description: Lançamento encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera um lançamento de simulação pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do lançamento in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – lancamentoSimulacao properties: lancamentoSimulacao: type: object allOf: – #/definitions/recLancamentoSimulacao description: Lançamento encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/listLancamentoSimulacao: post: description: Lista os lançamentos de simulação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Offset para paginação size: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recLancamentoSimulacao minimum: 1 description: Lista de lançamentos totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os lançamentos de simulação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Offset para paginação in: query type: integer format: int64 – name: size description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recLancamentoSimulacao minimum: 1 description: Lista de lançamentos totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/retrieveTemplatePercentual: post: description: Recupera um template de percentual pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do template responses: 200: description: Ok schema: type: object required: – templatePercentual properties: templatePercentual: type: object allOf: – #/definitions/recTemplatePercentual description: Template encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera um template de percentual pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do template in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – templatePercentual properties: templatePercentual: type: object allOf: – #/definitions/recTemplatePercentual description: Template encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/retrieveVisao: post: description: Recupera uma visão pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador da visão responses: 200: description: Ok schema: type: object required: – visao properties: visao: type: object allOf: – #/definitions/recVisao description: Visão encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera uma visão pelo identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador da visão in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – visao properties: visao: type: object allOf: – #/definitions/recVisao description: Visão encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/listVisao: post: description: Lista as visões tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Offset para paginação size: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recVisao minimum: 1 description: Lista de visões totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as visões tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Offset para paginação in: query type: integer format: int64 – name: size description: Quantidade de itens a ser retornada in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content – totalPages – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recVisao minimum: 1 description: Lista de visões totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/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 /fcx_fluxocaixa/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 /fcx_fluxocaixa/actions/gerarFluxoCaixa: post: description: Gera um Fluxo de Caixa com base nas parametrizações utilizadas.\nParâmetros:\n[in] visao\n[out] fluxoId\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visao – quantidade properties: visao: type: object allOf: – #/definitions/parametrizacao description: Visão com os parâmetros que definem a geração do fluxo de caixa quantidade: type: integer format: int64 description: Quantidade de períodos a serem gerados responses: 200: description: Ok schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/solicitarGeracaoParcelas: post: description: Solicita a geração de parcelas para uma rotina específica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipo – tamanhoLote properties: tipo: type: string allOf: – #/definitions/tipoRotinaGeracaoParcelas description: Tipo de rotina para geração de parcelas tamanhoLote: type: integer format: int64 description: Tamanho do lote de processamento responses: 200: description: Ok schema: type: object required: – quantidadeSolicitada properties: quantidadeSolicitada: type: integer format: int64 description: Quantidade de parcelas solicitadas para geração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/gerarFluxoCaixaVisao: post: description: Gera um fluxo de caixa a partir de uma visão previamente cadastrada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visaoId – quantidade properties: visaoId: type: integer format: int64 description: Identificador da visão quantidade: type: integer format: int64 description: Quantidade de períodos a serem gerados responses: 200: description: Ok schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/salvarFluxoCaixa: post: description: Salva um fluxo de caixa temporário com uma descrição tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao – fluxoId properties: descricao: type: string description: Descrição do fluxo de caixa fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se o fluxo foi salvo com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/removerFluxoCaixa: post: description: Remove um fluxo de caixa pelo identificador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se o fluxo foi removido com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/removerAgrupamento: post: description: Remove agrupamentos de um fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelGrupo properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelGrupo: type: array items: type: string minimum: 1 description: Lista de níveis de grupo a serem removidos responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se os agrupamentos foram removidos com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/aplicarCaracteristicaRotina: post: description: Aplica características de rotina (percentuais) a um fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – rotina properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa rotina: type: array items: type: object allOf: – #/definitions/caracteristicaRotina minimum: 1 description: Lista de características de rotina a serem aplicadas responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se as características foram aplicadas com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/excluirDetalheAgrupamento: post: description: Exclui um detalhe de agrupamento do fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelAfetado – detalheId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelAfetado: type: string description: Nível do agrupamento afetado detalheId: type: integer format: int64 description: Identificador do detalhe a ser excluído rateioId: type: integer format: int64 description: Identificador do rateio associado responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total atualizado do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos restantes do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/alterarDetalheAgrupamento: post: description: Altera um detalhe de agrupamento do fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelAfetado – detalheId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelAfetado: type: string description: Nível do agrupamento afetado detalheId: type: integer format: int64 description: Identificador do detalhe a ser alterado rateioId: type: integer format: int64 description: Identificador do rateio associado data: type: string format: date description: Nova data do detalhe valor: type: string description: Novo valor do detalhe responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total atualizado do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos atualizados do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/alterarValorAgrupamento: post: description: Altera o valor total de um agrupamento do fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelAfetado properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelAfetado: type: string description: Nível do agrupamento afetado novoValor: type: string description: Novo valor do agrupamento responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total atualizado do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos atualizados do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/inserirLancamentoAgrupamento: post: description: Insere um novo lançamento em um agrupamento do fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelAfetado – valor – observacao properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelAfetado: type: string description: Nível do agrupamento afetado valor: type: string description: Valor do lançamento observacao: type: string description: Observação do lançamento responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total atualizado do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos atualizados do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/excluirLancamentoAgrupamento: post: description: Exclui um lançamento de um agrupamento do fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelAfetado – lancamentoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelAfetado: type: string description: Nível do agrupamento afetado lancamentoId: type: integer format: int64 description: Identificador do lançamento a ser excluído responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total atualizado do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos restantes do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/alterarLancamentoAgrupamento: post: description: Altera um lançamento de um agrupamento do fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivelAfetado – lancamentoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa nivelAfetado: type: string description: Nível do agrupamento afetado lancamentoId: type: integer format: int64 description: Identificador do lançamento a ser alterado valor: type: string description: Novo valor do lançamento observacao: type: string description: Nova observação do lançamento responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: Total atualizado do agrupamento lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: Lista de lançamentos atualizados do agrupamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/cancelarSimulacao: post: description: Cancela simulações realizadas em um fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – cancelAll properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa cancelAll: type: boolean description: Indica se deve cancelar todas as simulações responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se o cancelamento foi realizado com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/efetivarSimulacaoDetalhes: post: description: Efetiva as simulações de detalhes realizadas em um fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se a efetivação foi realizada com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/gerarAplicacaoFinanceira: post: description: Gera uma simulação de aplicação financeira no fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – dataAplicacao – valorInvestido – percentual – prazoAplicacao properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa dataAplicacao: type: string format: date description: Data da aplicação valorInvestido: type: string description: Valor investido na aplicação percentual: type: number format: double description: Percentual de rendimento prazoAplicacao: type: integer format: int64 description: Prazo da aplicação em dias responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se a aplicação foi gerada com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/gerarEmprestimo: post: description: Gera uma simulação de empréstimo no fluxo de caixa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – dataContratacao – valorContratado – percentual – quantidadePrestacoes – diaDebito properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa dataContratacao: type: string format: date description: Data de contratação do empréstimo valorContratado: type: string description: Valor contratado do empréstimo percentual: type: number format: double description: Percentual de juros quantidadePrestacoes: type: integer format: int64 description: Quantidade de prestações diaDebito: type: integer format: int64 description: Dia do débito das prestações responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: Indica se o empréstimo foi gerado com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/imprimirFluxoCaixa: post: description: Imprime o fluxo de caixa no formato especificado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: Identificador do fluxo de caixa fluxoComparacao: type: array items: type: integer format: int64 description: Identificadores dos fluxos de comparação offset: type: integer format: int64 description: Último nível do período mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada formato: type: string allOf: – #/definitions/formatoImpressao description: Formato (Padrão: PDF) expandido: type: boolean description: Indica se a impressão deve ser expandida fuso: type: integer format: int64 description: Fuso horario do usuário responses: 200: description: Ok schema: type: object required: – download properties: download: type: string format: byte description: Arquivo binário para download 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/exportarDetalhes: post: description: Exportar detalhes de certa rotina e nível tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoId – nivel – rotina – tipoExportacao properties: fluxoId: type: integer format: int64 description: ID do fluxo nivel: type: string description: Nível do detalhe rotina: type: string allOf: – #/definitions/rotinaImpressao description: Rotina do detalhe tipoExportacao: type: string allOf: – #/definitions/enumTipoExportacao description: Tipo de exportação camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: Ordenação dos campos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/createMovimentoDiverso: post: description: Cria um novo movimento diverso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – movimentoDiverso properties: movimentoDiverso: type: object allOf: – #/definitions/recMovimentoDiverso description: Movimento diverso a ser criado responses: 200: description: Ok schema: type: object required: – movimentoDiverso properties: movimentoDiverso: type: object allOf: – #/definitions/recMovimentoDiverso description: Movimento diverso criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/updateMovimentoDiverso: post: description: Atualiza um movimento diverso existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – movimentoDiverso properties: movimentoDiverso: type: object allOf: – #/definitions/recMovimentoDiverso description: Movimento diverso a ser atualizado responses: 200: description: Ok schema: type: object required: – movimentoDiverso properties: movimentoDiverso: type: object allOf: – #/definitions/recMovimentoDiverso description: Movimento diverso atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/deleteMovimentoDiverso: post: description: Remove um movimento diverso pelo identificador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do movimento diverso responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/createCriterioDistribuicaoVencidos: post: description: Cria um novo critério de distribuição de vencidos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – criterioDistribuicaoVencidos properties: criterioDistribuicaoVencidos: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos description: Critério a ser criado responses: 200: description: Ok schema: type: object required: – criterioDistribuicaoVencidos properties: criterioDistribuicaoVencidos: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos description: Critério criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/updateCriterioDistribuicaoVencidos: post: description: Atualiza um critério de distribuição de vencidos existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – criterioDistribuicaoVencidos properties: criterioDistribuicaoVencidos: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos description: Critério a ser atualizado responses: 200: description: Ok schema: type: object required: – criterioDistribuicaoVencidos properties: criterioDistribuicaoVencidos: type: object allOf: – #/definitions/recCriterioDistribuicaoVencidos description: Critério atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/deleteCriterioDistribuicaoVencidos: post: description: Remove um critério de distribuição de vencidos pelo identificador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do critério responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/createLancamentoSimulacao: post: description: Cria um novo lançamento de simulação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lancamentoSimulacao properties: lancamentoSimulacao: type: object allOf: – #/definitions/recLancamentoSimulacao description: Lançamento a ser criado responses: 200: description: Ok schema: type: object required: – lancamentoSimulacao properties: lancamentoSimulacao: type: object allOf: – #/definitions/recLancamentoSimulacao description: Lançamento criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/updateLancamentoSimulacao: post: description: Atualiza um lançamento de simulação existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lancamentoSimulacao properties: lancamentoSimulacao: type: object allOf: – #/definitions/recLancamentoSimulacao description: Lançamento a ser atualizado responses: 200: description: Ok schema: type: object required: – lancamentoSimulacao properties: lancamentoSimulacao: type: object allOf: – #/definitions/recLancamentoSimulacao description: Lançamento atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/deleteLancamentoSimulacao: post: description: Remove um lançamento de simulação pelo identificador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do lançamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/createTemplatePercentual: post: description: Cria um novo template de percentual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – templatePercentual properties: templatePercentual: type: object allOf: – #/definitions/recTemplatePercentual description: Template a ser criado responses: 200: description: Ok schema: type: object required: – templatePercentual properties: templatePercentual: type: object allOf: – #/definitions/recTemplatePercentual description: Template criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/updateTemplatePercentual: post: description: Atualiza um template de percentual existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – templatePercentual properties: templatePercentual: type: object allOf: – #/definitions/recTemplatePercentual description: Template a ser atualizado responses: 200: description: Ok schema: type: object required: – templatePercentual properties: templatePercentual: type: object allOf: – #/definitions/recTemplatePercentual description: Template atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/deleteTemplatePercentual: post: description: Remove um template de percentual pelo identificador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do template responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/createVisao: post: description: Cria uma nova visão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visao properties: visao: type: object allOf: – #/definitions/recVisao description: Visão a ser criada responses: 200: description: Ok schema: type: object required: – visao properties: visao: type: object allOf: – #/definitions/recVisao description: Visão criada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/updateVisao: post: description: Atualiza uma visão existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visao properties: visao: type: object allOf: – #/definitions/recVisao description: Visão a ser atualizada responses: 200: description: Ok schema: type: object required: – visao properties: visao: type: object allOf: – #/definitions/recVisao description: Visão atualizada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/deleteVisao: post: description: Remove uma visão pelo identificador tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador da visão responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/signals/executarLimpezaCenarios: post: description: Faz o processo de limpeza dos cenários temporários antigos tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/events/startup: post: description: Evento disparado na inicialização do serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – dominio – servico properties: dominio: type: string description: Domínio do serviço servico: type: string description: Nome do serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/events/geracaoFluxoStatusChanged: post: description: Evento disparado quando o status da geração do fluxo de caixa é alterado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/statusFluxo responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: tipoRotinaGeracaoParcelas: type: string enum: – Pedido – OrdemCompra – ContratoCompra – ContratoVenda description: Tipos de rotina para geração de parcelas: * `Pedido` – Pedido de venda * `OrdemCompra` – Ordem de compra * `ContratoCompra` – Contrato de compra * `ContratoVenda` – Contrato de venda statusFluxoCaixa: type: string enum: – Temporario – EmProcessamento – Processado description: Status do fluxo de caixa: * `Temporario` – Fluxo temporário, ainda não salvo * `EmProcessamento` – Fluxo em processamento de geração * `Processado` – Fluxo processado e disponível para consulta rotinaImpressao: type: string enum: – ContasPagar – ContasPagarVencidos – ContasReceber – ContasReceberVencidos – Pedidos – ContratoVenda – ContratoCompra – OrdemCompra – MovimentoDiversoReceita – MovimentoDiversoDespesa – MovimentacoesDiversasDespesa – MovimentacoesDiversasReceita – AplicacaoFinanceira – Emprestimos – ServicoPontoVenda – Comissoes – TesourariaReceita – TesourariaDespesa – Tesouraria – ExtratoBancarioReceita – ExtratoBancarioDespesa – OrcamentosDespesa – OrcamentosReceita description: Rotinas de impressão: * `ContasPagar` – Contas a pagar * `ContasPagarVencidos` – Contas a pagar vencidos * `ContasReceber` – Contas a receber * `ContasReceberVencidos` – Contas a receber vencidos * `Pedidos` – Pedido * `ContratoVenda` – Contrato de venda * `ContratoCompra` – Contrato de compra * `OrdemCompra` – Ordem de compra * `MovimentoDiversoReceita` – Movimento diverso receita * `MovimentoDiversoDespesa` – Movimento diverso despesa * `MovimentacoesDiversasDespesa` – Movimento diverso despesa * `MovimentacoesDiversasReceita` – Movimento diverso receita * `AplicacaoFinanceira` – Aplicação financeira * `Emprestimos` – Empréstimos * `ServicoPontoVenda` – Serviço ponto venda * `Comissoes` – Comissões * `TesourariaReceita` – Tesouraria receita * `TesourariaDespesa` – Tesouraria despesa * `Tesouraria` – Tesouraria * `ExtratoBancarioReceita` – Extrato bancário receita * `ExtratoBancarioDespesa` – Extrato bancário despesa * `OrcamentosDespesa` – Orcamentaria receita * `OrcamentosReceita` – Orçamentaria despesa rotinaFluxo: type: string enum: – Nenhum – ContasPagar – ContasReceber – ContasReceberVencidos – ContasPagarVencidos – Pedido – ContratoVenda – ContratoCompra – OrdemCompra – MovimentoDiversoReceita – MovimentoDiversoDespesa – AplicacaoFinanceira – Emprestimo – ServicoPontoVenda – BaseHistoricaReceita – BaseHistoricaDespesa – OrcamentoDespesa – OrcamentoReceita – Comissao – TesourariaReceita – TesourariaDespesa – ExtratoBancario – Orcamentos description: Rotinas do fluxo de caixa: * `Nenhum` – Nenhuma rotina * `ContasPagar` – Contas a pagar * `ContasReceber` – Contas a receber * `ContasReceberVencidos` – Contas a receber vencidos * `ContasPagarVencidos` – Contas a pagar vencidos * `Pedido` – Pedido de venda * `ContratoVenda` – Contrato de venda * `ContratoCompra` – Contrato de compra * `OrdemCompra` – Ordem de compra * `MovimentoDiversoReceita` – Movimento diverso receita * `MovimentoDiversoDespesa` – Movimento diverso despesa * `AplicacaoFinanceira` – Aplicação financeira * `Emprestimo` – Empréstimo * `ServicoPontoVenda` – Serviço de ponto de venda * `BaseHistoricaReceita` – Base histórica receita * `BaseHistoricaDespesa` – Base histórica despesa * `OrcamentoDespesa` – Orçamento despesa * `OrcamentoReceita` – Orçamento receita * `Comissao` – Comissão * `TesourariaReceita` – Tesouraria receita * `TesourariaDespesa` – Tesouraria despesa * `ExtratoBancario` – Extrato bancário * `Orcamentos` – Orçamentos tipoOrigem: type: string enum: – Nenhum – Agrupador – Detalhe description: Tipo de origem da linha do fluxo: * `Nenhum` – Nenhum tipo * `Agrupador` – Linha agrupadora * `Detalhe` – Linha de detalhe tipoVisao: type: string enum: – Previsto – PrevistoReal – Realizado – Projetado – Orcamentaria – PrevistoCongelado description: Tipo de visão do fluxo de caixa: * `Previsto` – Visão prevista * `PrevistoReal` – Visão prevista com realizado * `Realizado` – Visão realizada * `Projetado` – Visão projetada * `Orcamentaria` – Visão orçamentária * `PrevistoCongelado` – Visão previsto congelado tipoVisaoMovimentoDiverso: type: string enum: – Previsto – PrevistoReal – Ambos description: Tipo de visão para movimento diverso: * `Previsto` – Somente previsto * `PrevistoReal` – Somente previsto com realizado * `Ambos` – Ambas as visões periodicidade: type: string enum: – Diario – Semanal – Quinzenal – Mensal – Trimestral – Semestral – Anual description: Periodicidade do fluxo de caixa: * `Diario` – Diário * `Semanal` – Semanal * `Quinzenal` – Quinzenal * `Mensal` – Mensal * `Trimestral` – Trimestral * `Semestral` – Semestral * `Anual` – Anual agrupamento: type: string enum: – ContaFinanceira – ContaContabil – CentroCustos – FormaPagamento – NaturezaGasto – OrigemInformacao – Projeto – ProjetoFase – Moeda description: Tipo de agrupamento do fluxo de caixa: * `ContaFinanceira` – Conta financeira * `ContaContabil` – Conta contábil * `CentroCustos` – Centro de custos * `FormaPagamento` – Forma de pagamento * `NaturezaGasto` – Natureza de gasto * `OrigemInformacao` – Origem da informação * `Projeto` – Projeto * `ProjetoFase` – Projeto e fase * `Moeda` – Moeda ordenacaoAgrupamento: type: string enum: – CodigoAbreviatura – Abreviatura – ClassificacaoAbreviatura – Descricao – CodigoDescricao description: Ordenação do agrupamento: * `CodigoAbreviatura` – Por código e abreviatura * `Abreviatura` – Por abreviatura * `ClassificacaoAbreviatura` – Por classificação e abreviatura * `Descricao` – Por descrição * `CodigoDescricao` – Por código e descrição aplicacaoFinanceiro: type: string enum: – Ambos – ContasPagar – ContasReceber description: Aplicação financeira (pagar, receber ou ambos): * `Ambos` – Ambas as aplicações * `ContasPagar` – Contas a pagar * `ContasReceber` – Contas a receber modulosTransacao: type: string enum: – CRE – CRP – CRB – CPE – CPP – CPB – VEP – VEF – VES – COO – COF – COS – CBM – CPM description: Módulos de transação: * `CRE` – CRE – Contas a receber entrada * `CRP` – CRP – Contas a receber parcial * `CRB` – CRB – Contas a receber baixa * `CPE` – CPE – Contas a pagar entrada * `CPP` – CPP – Contas a pagar parcial * `CPB` – CPB – Contas a pagar baixa * `VEP` – VEP – Venda pedido * `VEF` – VEF – Venda faturamento * `VES` – VES – Venda serviço * `COO` – COO – Compra ordem * `COF` – COF – Compra faturamento * `COS` – COS – Compra serviço * `CBM` – CBM – Correspondente bancário movimentação * `CPM` – CPM – Correspondente pagamento movimentação origemRealizado: type: string enum: – Baixas – Tesouraria – ExtratosBancarios – EntradaTitulosEfetivos description: Origem do realizado: * `Baixas` – Baixas de títulos * `Tesouraria` – Movimentos de tesouraria * `ExtratosBancarios` – Extratos bancários * `EntradaTitulosEfetivos` – Entrada de títulos efetivos baseHistorica: type: string enum: – Nenhum – MovimentacoesHistoricas – Orcamento description: Tipo de base histórica: * `Nenhum` – Nenhuma base histórica * `MovimentacoesHistoricas` – Movimentações históricas * `Orcamento` – Orçamento visualizacaoGrafico: type: string enum: – Valor – Percentual – PercentualValor description: Tipo de visualização do gráfico: * `Valor` – Somente valor * `Percentual` – Somente percentual * `PercentualValor` – Percentual e valor impressaoGrafico: type: string enum: – LinhaColunaPizza – LinhaPizzaColuna – ColunaPizzaColuna – BarraPizzaBarra – LinhaColunaColuna – BarraBarraBarra – ColunaColunaColuna description: Formato de impressão do gráfico: * `LinhaColunaPizza` – Linha, coluna e pizza * `LinhaPizzaColuna` – Linha, pizza e coluna * `ColunaPizzaColuna` – Coluna, pizza e coluna * `BarraPizzaBarra` – Barra, pizza e barra * `LinhaColunaColuna` – Linha, coluna e coluna * `BarraBarraBarra` – Barra, barra e barra * `ColunaColunaColuna` – Coluna, coluna e coluna origemSaldo: type: string enum: – Valor – ContaInterna – ExtratoBancario description: Origem do saldo inicial: * `Valor` – Valor digitado manualmente * `ContaInterna` – Saldo da conta interna * `ExtratoBancario` – Saldo do extrato bancário tipoDataSaldo: type: string enum: – DataMovimento – DataLiberacao description: Tipo de data para busca de saldo: * `DataMovimento` – Data do movimento * `DataLiberacao` – Data de liberação tipoBuscaMovimento: type: string enum: – DataMovimento – DataLiberacao – DataMovimentoPrevista description: Tipo de busca de movimento: * `DataMovimento` – Por data do movimento * `DataLiberacao` – Por data de liberação * `DataMovimentoPrevista` – Por data de movimento prevista tipoBuscaBaseHistorica: type: string enum: – RealizadoContasReceber – RealizadoContasPagar – RealizadoTesouraria – TitulosEfetivos – ExtratoBancario description: Tipo de busca da base histórica: * `RealizadoContasReceber` – Realizado contas a receber * `RealizadoContasPagar` – Realizado contas a pagar * `RealizadoTesouraria` – Realizado tesouraria * `TitulosEfetivos` – Títulos efetivos * `ExtratoBancario` – Extrato bancário categoriaTitulos: type: string enum: – Previstos – Efetivos – Ambos description: Categoria dos títulos: * `Previstos` – Somente previstos * `Efetivos` – Somente efetivos * `Ambos` – Ambas as categorias tipoVencimentoTitulo: type: string enum: – ProvavelPagamento – VencimentoOriginal – VencimentoProrrogado description: Tipo de vencimento do título: * `ProvavelPagamento` – Provável pagamento * `VencimentoOriginal` – Vencimento original * `VencimentoProrrogado` – Vencimento prorrogado origemTesouraria: type: string enum: – CM – CP – CR – CH – OU description: Origem do movimento de tesouraria: * `CM` – CM – Compensação * `CP` – CP – Conta própria * `CR` – CR – Crédito * `CH` – CH – Cheque * `OU` – OU – Outros tipoDistribuicao: type: string enum: – Nenhum – Diario – Mensal description: Tipo de distribuição de vencidos: * `Nenhum` – Nenhuma distribuição * `Diario` – Distribuição diária * `Mensal` – Distribuição mensal tipoParcela: type: string enum: – Ambas – ComParcelaEspecial – SemParcelaEspecial description: Tipo de parcela: * `Ambas` – Ambas as parcelas * `ComParcelaEspecial` – Com parcela especial * `SemParcelaEspecial` – Sem parcela especial tipoContrato: type: string enum: – ComercialNormal – ComercialAdicional – ComercialSocios – ComercialVariavel description: Tipo de contrato: * `ComercialNormal` – Comercial normal * `ComercialAdicional` – Comercial adicional * `ComercialSocios` – Comercial sócios * `ComercialVariavel` – Comercial variável criterioFaturamento: type: string enum: – QuantidadeParcela – Validade – Ambos description: Critério de faturamento: * `QuantidadeParcela` – Por quantidade de parcelas * `Validade` – Por validade * `Ambos` – Ambos os critérios situacaoComercial: type: string enum: – AbertoTotal – AbertoParcial – Suspenso – PreparacaoAnaliseNotaFiscal description: Situação comercial: * `AbertoTotal` – Aberto total * `AbertoParcial` – Aberto parcial * `Suspenso` – Suspenso * `PreparacaoAnaliseNotaFiscal` – Preparação análise nota fiscal origemOrcamento: type: string enum: – ContaFinanceira – ContaContabil – CentroCustos – Projeto – ProjetoFase – FormaPagamento description: Origem do orçamento: * `ContaFinanceira` – Conta financeira * `ContaContabil` – Conta contábil * `CentroCustos` – Centro de custos * `Projeto` – Projeto * `ProjetoFase` – Projeto e fase * `FormaPagamento` – Forma de pagamento origemOrcamentoCentroCustos: type: string enum: – Contabil – Financeiro – Projeto description: Origem do orçamento de centro de custos: * `Contabil` – Contábil * `Financeiro` – Financeiro * `Projeto` – Projeto origemOrcamentoProjetos: type: string enum: – RegimeEntrada – RegimeSaida description: Origem do orçamento de projetos: * `RegimeEntrada` – Regime de entrada * `RegimeSaida` – Regime de saída origemOrcamentoContaFinanceira: type: string enum: – Financeiro – Projeto description: Origem do orçamento de conta financeira: * `Financeiro` – Financeiro * `Projeto` – Projeto periodoFluxo: type: string enum: – EstaSemana – EstaQuinzena – EsteMes – EsteBimestre – EsteTrimestre – EsteSemestre – EsteAno – PeriodoDeAte description: Período do fluxo de caixa: * `EstaSemana` – Esta semana * `EstaQuinzena` – Esta quinzena * `EsteMes` – Este mês * `EsteBimestre` – Este bimestre * `EsteTrimestre` – Este trimestre * `EsteSemestre` – Este semestre * `EsteAno` – Este ano * `PeriodoDeAte` – Período de/até customizado tipoRecebimento: type: string enum: – CorrespondenteBancario – RecargaCelular – Ambos description: Tipo de recebimento do serviço de ponto de venda: * `CorrespondenteBancario` – Correspondente bancário * `RecargaCelular` – Recarga de celular * `Ambos` – Ambos os tipos tipoNaturezaGastos: type: string enum: – Normal – Recebimento – Transferencia description: Tipo de natureza de gastos: * `Normal` – Normal * `Recebimento` – Recebimento * `Transferencia` – Transferência tipoValor: type: string enum: – ValorAberto – ValorOriginal description: Tipo de valor do título: * `ValorAberto` – Valor aberto * `ValorOriginal` – Valor original naturezaMovimento: type: string enum: – Credito – Debito description: Natureza do movimento: * `Credito` – Crédito * `Debito` – Débito tipoTotaisContas: type: string enum: – Analitico – Sintetico – Ambos description: Tipo de totais de contas: * `Analitico` – Analítico * `Sintetico` – Sintético * `Ambos` – Ambos aplicacaoMercadoSuprimentos: type: string enum: – Compras – Vendas – Ambos description: Aplicação mercado/suprimentos: * `Compras` – Compras * `Vendas` – Vendas * `Ambos` – Ambos buscaVencimentoContasReceber: type: string enum: – FloatBancario – AtrasoMedio – PrazoMedio description: Busca de vencimento para contas a receber: * `FloatBancario` – Float bancário * `AtrasoMedio` – Atraso médio * `PrazoMedio` – Prazo médio calculoFinanceiroTitulos: type: string enum: – Juros – Multa – Descontos – Reajuste – OutrosAcrescimos – CorrecaoMonetaria description: Cálculo financeiro aplicado aos títulos: * `Juros` – Juros * `Multa` – Multa * `Descontos` – Descontos * `Reajuste` – Reajuste * `OutrosAcrescimos` – Outros acréscimos * `CorrecaoMonetaria` – Correção monetária tipoOrdenacao: type: string enum: – Crescente – Decrescente description: Tipo de ordenação: * `Crescente` – Crescente * `Decrescente` – Decrescente impostos: type: string enum: – IRRF – INSS – ISS – COFINS – PIS – CSLL – OutrasRetencoes description: Impostos aplicáveis: * `IRRF` – Imposto de renda retido na fonte * `INSS` – INSS * `ISS` – ISS * `COFINS` – COFINS * `PIS` – PIS * `CSLL` – CSLL * `OutrasRetencoes` – Outras retenções enumTipoExportacao: type: string enum: – XLS – XLSX description: Tipo de exportação: * `XLS` – Formato XLS * `XLSX` – Formato XLSX rotinaAlterada: type: string enum: – Pedido – ContratoVenda – TituloReceberPrevisto – TituloReceberEfetivo – TituloReceberVencidos – TituloReceberRealizado – TituloReceberPrevistoCongelado – TituloPagarPrevistoCongelado – OrdemCompra – ContratoCompra – TituloPagarEfetivo – TituloPagarPrevisto – TituloPagarRealizado – TituloPagarVencidos – TesourariaReceita – TesourariaDespesa – OrcamentoReceita – OrcamentoDespesa – ComissaoNormal – ComissaoSimulada – MovimentoDiversoReceita – MovimentoDiversoDespesa – AplicacaoFinanceira – Emprestimo – ServicoPontoVendaOperadora – ServicoPontoVendaCorrespondente – BaseHistoricaReceita – BaseHistoricaDespesa – ExtratoBancarioReceita – ExtratoBancarioDespesa description: Rotina alterada no fluxo: * `Pedido` – Pedido * `ContratoVenda` – Contrato de venda * `TituloReceberPrevisto` – Título a receber previsto * `TituloReceberEfetivo` – Título a receber efetivo * `TituloReceberVencidos` – Título a receber vencidos * `TituloReceberRealizado` – Título a receber realizado * `TituloReceberPrevistoCongelado` – Título a receber previsto congelado * `TituloPagarPrevistoCongelado` – Título a pagar previsto congelado * `OrdemCompra` – Ordem de compra * `ContratoCompra` – Contrato de compra * `TituloPagarEfetivo` – Título a pagar efetivo * `TituloPagarPrevisto` – Título a pagar previsto * `TituloPagarRealizado` – Título a pagar realizado * `TituloPagarVencidos` – Título a pagar vencidos * `TesourariaReceita` – Tesouraria receita * `TesourariaDespesa` – Tesouraria despesa * `OrcamentoReceita` – Orçamento receita * `OrcamentoDespesa` – Orçamento despesa * `ComissaoNormal` – Comissão normal * `ComissaoSimulada` – Comissão simulada * `MovimentoDiversoReceita` – Movimento diverso receita * `MovimentoDiversoDespesa` – Movimento diverso despesa * `AplicacaoFinanceira` – Aplicação financeira * `Emprestimo` – Empréstimo * `ServicoPontoVendaOperadora` – Serviço ponto venda – operadora * `ServicoPontoVendaCorrespondente` – Serviço ponto venda – correspondente * `BaseHistoricaReceita` – Base histórica receita * `BaseHistoricaDespesa` – Base histórica despesa * `ExtratoBancarioReceita` – Extrato bancário receita * `ExtratoBancarioDespesa` – Extrato bancário despesa formatoImpressao: type: string enum: – PDF_NORMAL – PDF_RESUMIDO – PDF_EXPANDIDO – TXT – XLS – XLSX description: Formato de impressão do fluxo: * `PDF_NORMAL` – PDF normal * `PDF_RESUMIDO` – PDF resumido * `PDF_EXPANDIDO` – PDF expandido * `TXT` – Texto * `XLS` – XLS * `XLSX` – XLSX filtroExtratos: type: string enum: – Conciliados – NaoConciliados – Todos description: Filtro de extratos bancários: * `Conciliados` – Somente conciliados * `NaoConciliados` – Somente não conciliados * `Todos` – Todos os extratos enumVisualizacaoNiveis: type: string enum: – NiveisLancamento – NiveisSinteticos – TodosNiveis description: Visualização de níveis do fluxo: * `NiveisLancamento` – Somente níveis de lançamento * `NiveisSinteticos` – Somente níveis sintéticos * `TodosNiveis` – Todos os níveis divisaoBaseHistorica: type: string enum: – PeriodoDestino – PeriodoOrigem description: Divisão da base histórica: * `PeriodoDestino` – Por período de destino * `PeriodoOrigem` – Por período de origem upDown: type: string enum: – UP – DOWN description: Status up ou down: * `UP` – Serviço disponível * `DOWN` – Serviço indisponível 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 dadosComparacaoFluxo: description: Dados de comparação entre fluxos de caixa type: object required: – idFluxo – saldo – contasReceber – contasPagar properties: idFluxo: type: integer format: int64 description: Identificador do fluxo de caixa saldo: type: string description: Saldo do fluxo contasReceber: type: string description: Total de contas a receber contasPagar: type: string description: Total de contas a pagar estruturaLinha: description: Estrutura de uma linha do fluxo de caixa discriminator: _discriminator type: object required: – nivel – valor – _discriminator properties: nivel: type: string description: Nível hierárquico da linha valor: type: string description: Valor monetário da linha fluxoCaixaId: type: integer format: int64 description: Identificador do fluxo de caixa associado _discriminator: type: string description: estruturaLinhaComparacao: description: Estrutura de linha com dados de comparação entre fluxos allOf: – #/definitions/estruturaLinha – type: object required: – diferenca – percentualDiferenca properties: diferenca: type: string description: Diferença entre os valores comparados percentualDiferenca: type: number format: double description: Percentual da diferença linhaFluxo: description: Linha do fluxo de caixa com hierarquia e detalhes type: object required: – nivel – label – hierarquia – descricaoEmpresa – tipo – percentual – rotina – linha – filhos properties: nivel: type: string description: Nível hierárquico da linha label: type: string description: Rótulo de exibição da linha hierarquia: type: string description: Caminho hierárquico da linha descricaoEmpresa: type: string description: Descrição da empresa tipo: type: string allOf: – #/definitions/tipoOrigem description: Tipo de origem (agrupador ou detalhe) percentual: type: number format: double description: Percentual aplicado sobre a linha rotina: type: string description: Rotina de origem dos dados linha: type: array items: type: object allOf: – #/definitions/estruturaLinha minimum: 1 description: Estruturas de valores por período filhos: type: array items: type: object allOf: – #/definitions/linhaFluxo minimum: 1 description: Linhas filhas na hierarquia tituloReceberInicializacao: description: Dados de inicialização de título a receber type: object required: – empresaId – filialId – numeroTitulo – tipoTipoId – clienteId – portadorId – original – provavel – prorrogado properties: empresaId: type: integer format: int64 description: Identificador da empresa filialId: type: integer format: int64 description: Identificador da filial numeroTitulo: type: string description: Número do título tipoTipoId: type: string description: Identificador do tipo de título clienteId: type: integer format: int64 description: Identificador do cliente portadorId: type: integer format: int64 description: Identificador do portador original: type: string format: date description: Data de vencimento original provavel: type: string format: date description: Data de vencimento provável prorrogado: type: string format: date description: Data de vencimento prorrogado idG7: type: integer format: int64 description: Identificador legado G7 tituloPagarInicializacao: description: Dados de inicialização de título a pagar type: object required: – empresaId – filialId – numeroTitulo – tipoTipoId – fornecedorId – original – provavel – prorrogado properties: empresaId: type: integer format: int64 description: Identificador da empresa filialId: type: integer format: int64 description: Identificador da filial numeroTitulo: type: string description: Número do título tipoTipoId: type: string description: Identificador do tipo de título fornecedorId: type: integer format: int64 description: Identificador do fornecedor original: type: string format: date description: Data de vencimento original provavel: type: string format: date description: Data de vencimento provável prorrogado: type: string format: date description: Data de vencimento prorrogado idG7: type: integer format: int64 description: Identificador legado G7 historicoCliente: description: Dados de histórico do cliente type: object required: – empresaId – filialId – clienteId properties: empresaId: type: integer format: int64 description: Identificador da empresa filialId: type: integer format: int64 description: Identificador da filial clienteId: type: integer format: int64 description: Identificador do cliente datasTitulos: description: Datas calculadas para títulos type: object required: – originalUtil – originalFloat – originalAtraso – originalPrazo – originalFloatAtraso – originalFloatPrazo – originalAtrasoPrazo – originalFloatAtrasoPrazo – provavelUtil – provavelFloat – provavelAtraso – provavelPrazo – provavelFloatAtraso – provavelFloatPrazo – provavelAtrasoPrazo – provavelFloatAtrasoPrazo – prorrogadoUtil – prorrogadoFloat – prorrogadoAtraso – prorrogadoPrazo – prorrogadoFloatAtraso – prorrogadoFloatPrazo – prorrogadoAtrasoPrazo – prorrogadoFloatAtrasoPrazo properties: originalUtil: type: string format: date description: Data original em dia útil originalFloat: type: string format: date description: Data original com float bancário originalAtraso: type: string format: date description: Data original com atraso originalPrazo: type: string format: date description: Data original com prazo originalFloatAtraso: type: string format: date description: Data original com float e atraso originalFloatPrazo: type: string format: date description: Data original com float e prazo originalAtrasoPrazo: type: string format: date description: Data original com atraso e prazo originalFloatAtrasoPrazo: type: string format: date description: Data original com float, atraso e prazo provavelUtil: type: string format: date description: Data provável em dia útil provavelFloat: type: string format: date description: Data provável com float bancário provavelAtraso: type: string format: date description: Data provável com atraso provavelPrazo: type: string format: date description: Data provável com prazo provavelFloatAtraso: type: string format: date description: Data provável com float e atraso provavelFloatPrazo: type: string format: date description: Data provável com float e prazo provavelAtrasoPrazo: type: string format: date description: Data provável com atraso e prazo provavelFloatAtrasoPrazo: type: string format: date description: Data provável com float, atraso e prazo prorrogadoUtil: type: string format: date description: Data prorrogada em dia útil prorrogadoFloat: type: string format: date description: Data prorrogada com float bancário prorrogadoAtraso: type: string format: date description: Data prorrogada com atraso prorrogadoPrazo: type: string format: date description: Data prorrogada com prazo prorrogadoFloatAtraso: type: string format: date description: Data prorrogada com float e atraso prorrogadoFloatPrazo: type: string format: date description: Data prorrogada com float e prazo prorrogadoAtrasoPrazo: type: string format: date description: Data prorrogada com atraso e prazo prorrogadoFloatAtrasoPrazo: type: string format: date description: Data prorrogada com float, atraso e prazo datasCalculadasReceber: description: Datas calculadas para título a receber type: object required: – titulos – datas properties: titulos: type: object allOf: – #/definitions/tituloReceberInicializacao description: Título a receber de origem datas: type: object allOf: – #/definitions/datasTitulos description: Datas calculadas datasCalculadasPagar: description: Datas calculadas para título a pagar type: object required: – titulos – datas properties: titulos: type: object allOf: – #/definitions/tituloPagarInicializacao description: Título a pagar de origem datas: type: object allOf: – #/definitions/datasTitulos description: Datas calculadas parametrizacaoResumida: description: Resumo da parametrização para listagem type: object required: – id – descricao – tipoVisao – periodicidade – agrupamento – usuarioGeracao – dataGeracao – favorita properties: id: type: integer format: int64 description: Identificador da parametrização descricao: type: string description: Descrição da parametrização tipoVisao: type: string description: Tipo de visão periodicidade: type: string description: Periodicidade do fluxo agrupamento: type: string description: Tipo de agrupamento dataBase: type: string format: date description: Data base da parametrização considerarDiaNaoUtil: type: boolean description: Indica se considera dia não útil usuarioGeracao: type: string description: Usuário que criou a parametrização usuarioAlteracao: type: string description: Usuário que alterou a parametrização dataGeracao: type: string description: Data de criação dataAlteracao: type: string description: Data de alteração favorita: type: boolean description: Indica se é favorita movimentoDiversoResumido: description: Resumo do movimento diverso para listagem type: object required: – id – empresa – filial – dataMovimento – tipoMovimento – tipoAgrupamento – valorMovimento – usuarioAlteracao – dataAlteracao – descricao properties: id: type: integer format: int64 description: Identificador do movimento empresa: type: object allOf: – #/definitions/empresa description: Empresa do movimento filial: type: object allOf: – #/definitions/filial description: Filial do movimento dataMovimento: type: string description: Data do movimento tipoMovimento: type: string allOf: – #/definitions/naturezaMovimento description: Tipo do movimento (crédito/débito) tipoAgrupamento: type: array items: type: string allOf: – #/definitions/agrupamento minimum: 1 description: Tipos de agrupamento do movimento valorMovimento: type: string description: Valor do movimento usuarioAlteracao: type: string description: Usuário que alterou dataAlteracao: type: string description: Data de alteração descricao: type: string description: Descrição do movimento criterioDistribuicaoResumido: description: Resumo do critério de distribuição para listagem type: object required: – id – descricao – tipoDistribuicao – usuarioAlteracao – dataAlteracao properties: id: type: integer format: int64 description: Identificador do critério descricao: type: string description: Descrição do critério tipoDistribuicao: type: string allOf: – #/definitions/tipoDistribuicao description: Tipo de distribuição usuarioAlteracao: type: string description: Usuário que alterou dataAlteracao: type: string description: Data de alteração fluxoResumido: description: Resumo do fluxo de caixa gerado type: object required: – id – descricao – tipoVisao – periodicidade – agrupamento – usuarioGeracao properties: id: type: integer format: int64 description: Identificador do fluxo descricao: type: string description: Descrição do fluxo tipoVisao: type: string allOf: – #/definitions/tipoVisao description: Tipo de visão periodicidade: type: string allOf: – #/definitions/periodicidade description: Periodicidade agrupamento: type: string allOf: – #/definitions/agrupamento description: Tipo de agrupamento ordenacaoAgrupamento: type: string allOf: – #/definitions/ordenacaoAgrupamento description: Ordenação do agrupamento dataBase: type: string format: date description: Data base do fluxo considerarDiaNaoUtil: type: boolean description: Indica se considera dia não útil usuarioGeracao: type: string description: Usuário que gerou o fluxo dataGeracao: type: string format: date-time description: Data de geração usuarioAlteracao: type: string description: Usuário que alterou o fluxo dataAlteracao: type: string format: date-time description: Data de alteração situacao: type: string description: Situação do fluxo limiteCredito: type: string description: Limite de crédito periodo: description: Período do fluxo de caixa type: object required: – label – itens properties: label: type: string description: Rótulo do período itens: type: array items: type: string minimum: 1 description: Itens do período dataPeriodo: description: Data de um período type: object required: – label – valor properties: label: type: string description: Rótulo da data valor: type: string description: Valor da data saldo: description: Saldo monetário type: object required: – label – valor properties: label: type: string description: Rótulo do saldo valor: type: string description: Valor do saldo campoOrdenacao: description: Campo de ordenação para consultas type: object required: – campo – ordem properties: campo: type: string description: Nome do campo ordem: type: string allOf: – #/definitions/tipoOrdenacao description: Direção da ordenação detalheGeral: description: Detalhe geral de um item do fluxo de caixa discriminator: _discriminator type: object required: – id – idEmpresa – nomeFantasiaEmpresa – idFilial – nomeFilial – dataPadrao – dataUtilizada – valorLiquido – _discriminator properties: id: type: integer format: int64 description: Identificador do detalhe idEmpresa: type: integer format: int64 description: Identificador da empresa nomeFantasiaEmpresa: type: string description: Nome fantasia da empresa idFilial: type: integer format: int64 description: Identificador da filial nomeFilial: type: string description: Nome da filial dataPadrao: type: string format: date description: Data padrão do movimento dataUtilizada: type: string format: date description: Data utilizada no fluxo valorLiquido: type: string description: Valor líquido do movimento idRateio: type: integer format: int64 description: Identificador do rateio valorRateio: type: string description: Valor do rateio dataGeracao: type: string format: date-time description: Data de geração do detalhe usuarioGeracao: type: string description: Usuário que gerou o detalhe _discriminator: type: string description: detalheTituloReceber: description: Detalhe de título a receber allOf: – #/definitions/detalheGeral – type: object required: – idCliente – nomeCliente – numeroTitulo – idTipoTitulo – descricaoTipoTitulo – idPortador – descricaoPortador – idCarteira – descricaoCarteira – idSituacaoTitulo – descricaoSituacaoTitulo – indicativoProprio – idFormaPagamento – descricaoFormaPagamento – idNaturezaGastos – descricaoNaturezaGastos – observacao – status – idMoeda – idTransacaoEntrada – descricaoTransacaoEntrada – idTransacaoBaixa – descricaoTransacaoBaixa – tipoVencimento – composicaoValorLiquido properties: idCliente: type: integer format: int64 description: Identificador do cliente nomeCliente: type: string description: Nome do cliente numeroTitulo: type: string description: Número do título idTipoTitulo: type: string description: Identificador do tipo de título descricaoTipoTitulo: type: string description: Descrição do tipo de título idPortador: type: string description: Identificador do portador descricaoPortador: type: string description: Descrição do portador idCarteira: type: string description: Identificador da carteira descricaoCarteira: type: string description: Descrição da carteira idSituacaoTitulo: type: string description: Identificador da situação do título descricaoSituacaoTitulo: type: string description: Descrição da situação do título indicativoProprio: type: string description: Indicativo de título próprio idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idNaturezaGastos: type: integer format: int64 description: Identificador da natureza de gastos descricaoNaturezaGastos: type: string description: Descrição da natureza de gastos observacao: type: string description: Observação do título status: type: integer format: int64 description: Status do título descricaoStatus: type: string description: Descrição do status idMoeda: type: string description: Identificador da moeda idTransacaoEntrada: type: string description: Identificador da transação de entrada descricaoTransacaoEntrada: type: string description: Descrição da transação de entrada idTransacaoBaixa: type: string description: Identificador da transação de baixa descricaoTransacaoBaixa: type: string description: Descrição da transação de baixa tipoVencimento: type: string description: Tipo de vencimento utilizado composicaoValorLiquido: type: object allOf: – #/definitions/composicaoValorLiquidoTituloReceber description: Composição do valor líquido detalhePedido: description: Detalhe de pedido de venda allOf: – #/definitions/detalheGeral – type: object required: – idCliente – nomeCliente – numeroPedido – parcela – idFormaPagamento – descricaoFormaPagamento – idCondicaoPagamento – descricaoCondicaoPagamento – idTransacao – descricaoTransacao – idMoeda – cotacaoItem – parcelaEspecial – produto properties: idCliente: type: integer format: int64 description: Identificador do cliente nomeCliente: type: string description: Nome do cliente numeroPedido: type: integer format: int64 description: Número do pedido parcela: type: integer format: int64 description: Número da parcela idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idCondicaoPagamento: type: string description: Identificador da condição de pagamento descricaoCondicaoPagamento: type: string description: Descrição da condição de pagamento idTransacao: type: string description: Identificador da transação descricaoTransacao: type: string description: Descrição da transação idMoeda: type: string description: Identificador da moeda cotacaoItem: type: number format: double description: Cotação do item parcelaEspecial: type: string description: Indicativo de parcela especial produto: type: string description: Produto do pedido detalheContratoVenda: description: Detalhe de contrato de venda allOf: – #/definitions/detalheGeral – type: object required: – idCliente – nomeCliente – numeroContrato – tipoContrato – descricaoTipoContrato – parcela – idFormaPagamento – descricaoFormaPagamento – idMotivo – descricaoMotivo – criterioFaturamento – idTransacao – descricaoTransacao – idCondicaoPagamento – descricaoCondicaoPagamento – idMoeda – cotacaoItem – produto properties: idCliente: type: integer format: int64 description: Identificador do cliente nomeCliente: type: string description: Nome do cliente numeroContrato: type: integer format: int64 description: Número do contrato tipoContrato: type: integer format: int64 description: Tipo do contrato descricaoTipoContrato: type: string description: Descrição do tipo de contrato parcela: type: integer format: int64 description: Número da parcela idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idMotivo: type: integer format: int64 description: Identificador do motivo descricaoMotivo: type: string description: Descrição do motivo criterioFaturamento: type: string description: Critério de faturamento idTransacao: type: string description: Identificador da transação descricaoTransacao: type: string description: Descrição da transação idCondicaoPagamento: type: string description: Identificador da condição de pagamento descricaoCondicaoPagamento: type: string description: Descrição da condição de pagamento idMoeda: type: string description: Identificador da moeda cotacaoItem: type: number format: double description: Cotação do item produto: type: string description: Produto do contrato detalheOrdemCompra: description: Detalhe de ordem de compra allOf: – #/definitions/detalheGeral – type: object required: – idFornecedor – nomeFornecedor – parcela – numeroOrdemCompra – idFormaPagamento – descricaoFormaPagamento – idTransacao – descricaoTransacao – idCondicaoPagamento – descricaoCondicaoPagamento – idMoeda – cotacaoItem – parcelaEspecial – produto properties: idFornecedor: type: integer format: int64 description: Identificador do fornecedor nomeFornecedor: type: string description: Nome do fornecedor parcela: type: integer format: int64 description: Número da parcela numeroOrdemCompra: type: integer format: int64 description: Número da ordem de compra idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idTransacao: type: string description: Identificador da transação descricaoTransacao: type: string description: Descrição da transação idCondicaoPagamento: type: string description: Identificador da condição de pagamento descricaoCondicaoPagamento: type: string description: Descrição da condição de pagamento idMoeda: type: string description: Identificador da moeda cotacaoItem: type: number format: double description: Cotação do item parcelaEspecial: type: string description: Indicativo de parcela especial produto: type: string description: Produto da ordem detalheContratoCompra: description: Detalhe de contrato de compra allOf: – #/definitions/detalheGeral – type: object required: – idFornecedor – nomeFornecedor – numeroContrato – tipoContrato – descricaoTipoContrato – parcela – idCondicaoPagamento – descricaoCondicaoPagamento – idFormaPagamento – descricaoFormaPagamento – idMotivo – descricaoMotivo – idTransacao – descricaoTransacao – idMoeda – cotacaoItem – produto properties: idFornecedor: type: integer format: int64 description: Identificador do fornecedor nomeFornecedor: type: string description: Nome do fornecedor numeroContrato: type: integer format: int64 description: Número do contrato tipoContrato: type: integer format: int64 description: Tipo do contrato descricaoTipoContrato: type: string description: Descrição do tipo de contrato parcela: type: integer format: int64 description: Número da parcela idCondicaoPagamento: type: string description: Identificador da condição de pagamento descricaoCondicaoPagamento: type: string description: Descrição da condição de pagamento idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idMotivo: type: integer format: int64 description: Identificador do motivo descricaoMotivo: type: string description: Descrição do motivo idTransacao: type: string description: Identificador da transação descricaoTransacao: type: string description: Descrição da transação idMoeda: type: string description: Identificador da moeda cotacaoItem: type: number format: double description: Cotação do item produto: type: string description: Produto do contrato detalheTituloPagar: description: Detalhe de título a pagar allOf: – #/definitions/detalheGeral – type: object required: – idFornecedor – nomeFornecedor – numeroTitulo – idTipoTitulo – descricaoTipoTitulo – idPortador – descricaoPortador – idCarteira – descricaoCarteira – idSituacaoTitulo – descricaoSituacaoTitulo – idFormaPagamento – descricaoFormaPagamento – idNaturezaGastos – descricaoNaturezaGastos – observacao – status – idMoeda – idTransacaoEntrada – descricaoTransacaoEntrada – idTransacaoBaixa – descricaoTransacaoBaixa – idGrupo – descricaoGrupo – tipoVencimento – composicaoValorLiquido properties: idFornecedor: type: integer format: int64 description: Identificador do fornecedor nomeFornecedor: type: string description: Nome do fornecedor numeroTitulo: type: string description: Número do título idTipoTitulo: type: string description: Identificador do tipo de título descricaoTipoTitulo: type: string description: Descrição do tipo de título idPortador: type: string description: Identificador do portador descricaoPortador: type: string description: Descrição do portador idCarteira: type: string description: Identificador da carteira descricaoCarteira: type: string description: Descrição da carteira idSituacaoTitulo: type: string description: Identificador da situação do título descricaoSituacaoTitulo: type: string description: Descrição da situação do título idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idNaturezaGastos: type: integer format: int64 description: Identificador da natureza de gastos descricaoNaturezaGastos: type: string description: Descrição da natureza de gastos observacao: type: string description: Observação do título status: type: integer format: int64 description: Status do título descricaoStatus: type: string description: Descrição do status idMoeda: type: string description: Identificador da moeda idTransacaoEntrada: type: string description: Identificador da transação de entrada descricaoTransacaoEntrada: type: string description: Descrição da transação de entrada idTransacaoBaixa: type: string description: Identificador da transação de baixa descricaoTransacaoBaixa: type: string description: Descrição da transação de baixa idGrupo: type: string description: Identificador do grupo descricaoGrupo: type: string description: Descrição do grupo tipoVencimento: type: string description: Tipo de vencimento utilizado composicaoValorLiquido: type: object allOf: – #/definitions/composicaoValorLiquidoTituloPagar description: Composição do valor líquido detalheTesouraria: description: Detalhe de movimento de tesouraria allOf: – #/definitions/detalheGeral – type: object required: – idContaInterna – descricaoContaInterna – historicoMovimento – sequenciaMovimento – sequenciaPreparacao – origemMovimento – descricaoOrigem – numeroDocumento – numeroCheque – idNaturezaGastos – descricaoNaturezaGastos – idTransacao – descricaoTransacao – idTipoContaInterna – descricaoTipoContaInterna – movimentoBloqueado – observacao properties: idContaInterna: type: string description: Identificador da conta interna descricaoContaInterna: type: string description: Descrição da conta interna historicoMovimento: type: string description: Histórico do movimento sequenciaMovimento: type: integer format: int64 description: Sequência do movimento sequenciaPreparacao: type: string description: Sequência de preparação origemMovimento: type: string description: Origem do movimento descricaoOrigem: type: string description: Descrição da origem numeroDocumento: type: string description: Número do documento numeroCheque: type: integer format: int64 description: Número do cheque idNaturezaGastos: type: integer format: int64 description: Identificador da natureza de gastos descricaoNaturezaGastos: type: string description: Descrição da natureza de gastos idTransacao: type: string description: Identificador da transação descricaoTransacao: type: string description: Descrição da transação idTipoContaInterna: type: string description: Identificador do tipo de conta interna descricaoTipoContaInterna: type: string description: Descrição do tipo de conta interna movimentoBloqueado: type: string description: Indica se o movimento está bloqueado observacao: type: string description: Observação do movimento detalheExtratoBancario: description: Detalhe de extrato bancário allOf: – #/definitions/detalheGeral – type: object required: – idContaInterna – descricaoContaInterna – historicoExtrato – sequenciaExtrato – numeroDocumento – numeroCheque – idTipoContaInterna – descricaoTipoContaInterna – conciliado properties: idContaInterna: type: string description: Identificador da conta interna descricaoContaInterna: type: string description: Descrição da conta interna historicoExtrato: type: string description: Histórico do extrato sequenciaExtrato: type: integer format: int64 description: Sequência do extrato numeroDocumento: type: string description: Número do documento numeroCheque: type: integer format: int64 description: Número do cheque idTipoContaInterna: type: string description: Identificador do tipo de conta interna descricaoTipoContaInterna: type: string description: Descrição do tipo de conta interna conciliado: type: string description: Indica se está conciliado detalheEmprestimos: description: Detalhe de empréstimos allOf: – #/definitions/detalheGeral – type: object required: – idContratoAplicacao – descricaoContratoAplicacao – idProdutoBancario – descricaoProdutoBancario – idCalculoContrato – descricaoCalculoContrato – idFornecedor – nomeFornecedor – numeroTitulo – idTipoTitulo – descricaoTipoTitulo – idPortador – descricaoPortador – idCarteira – descricaoCarteira – idSituacaoTitulo – descricaoSituacaoTitulo – idFormaPagamento – descricaoFormaPagamento – idNaturezaGastos – descricaoNaturezaGastos – observacao – status – idMoeda – idTransacaoEntrada – descricaoTransacaoEntrada – idTransacaoBaixa – descricaoTransacaoBaixa – idGrupo – descricaoGrupo – tipoVencimento – composicaoValorLiquido properties: idContratoAplicacao: type: integer format: int64 description: Identificador do contrato de aplicação descricaoContratoAplicacao: type: string description: Descrição do contrato de aplicação idProdutoBancario: type: integer format: int64 description: Identificador do produto bancário descricaoProdutoBancario: type: string description: Descrição do produto bancário idCalculoContrato: type: integer format: int64 description: Identificador do cálculo do contrato descricaoCalculoContrato: type: string description: Descrição do cálculo do contrato idFornecedor: type: integer format: int64 description: Identificador do fornecedor nomeFornecedor: type: string description: Nome do fornecedor numeroTitulo: type: string description: Número do título idTipoTitulo: type: string description: Identificador do tipo de título descricaoTipoTitulo: type: string description: Descrição do tipo de título idPortador: type: string description: Identificador do portador descricaoPortador: type: string description: Descrição do portador idCarteira: type: string description: Identificador da carteira descricaoCarteira: type: string description: Descrição da carteira idSituacaoTitulo: type: string description: Identificador da situação do título descricaoSituacaoTitulo: type: string description: Descrição da situação do título idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idNaturezaGastos: type: integer format: int64 description: Identificador da natureza de gastos descricaoNaturezaGastos: type: string description: Descrição da natureza de gastos observacao: type: string description: Observação status: type: integer format: int64 description: Status do título idMoeda: type: string description: Identificador da moeda idTransacaoEntrada: type: string description: Identificador da transação de entrada descricaoTransacaoEntrada: type: string description: Descrição da transação de entrada idTransacaoBaixa: type: string description: Identificador da transação de baixa descricaoTransacaoBaixa: type: string description: Descrição da transação de baixa idGrupo: type: string description: Identificador do grupo descricaoGrupo: type: string description: Descrição do grupo tipoVencimento: type: string description: Tipo de vencimento utilizado composicaoValorLiquido: type: object allOf: – #/definitions/composicaoValorLiquidoTituloPagar description: Composição do valor líquido detalheAplicacaoFinanceira: description: Detalhe de aplicação financeira allOf: – #/definitions/detalheGeral – type: object required: – idContaInterna – descricaoContaInterna – sequenciaMovimento – historicoMovimento – idNaturezaGastos – descricaoNaturezaGastos – idTransacao – descricaoTransacao – contratoAplicacao – descricaoContratoAplicacao – idProdutoBancario – descricaoProdutoBancario – idCalculoContrato – descricaoCalculoContrato properties: idContaInterna: type: string description: Identificador da conta interna descricaoContaInterna: type: string description: Descrição da conta interna sequenciaMovimento: type: integer format: int64 description: Sequência do movimento historicoMovimento: type: string description: Histórico do movimento idNaturezaGastos: type: integer format: int64 description: Identificador da natureza de gastos descricaoNaturezaGastos: type: string description: Descrição da natureza de gastos idTransacao: type: string description: Identificador da transação descricaoTransacao: type: string description: Descrição da transação contratoAplicacao: type: integer format: int64 description: Número do contrato de aplicação descricaoContratoAplicacao: type: string description: Descrição do contrato de aplicação idProdutoBancario: type: integer format: int64 description: Identificador do produto bancário descricaoProdutoBancario: type: string description: Descrição do produto bancário idCalculoContrato: type: integer format: int64 description: Identificador do cálculo do contrato descricaoCalculoContrato: type: string description: Descrição do cálculo do contrato detalheServicoPontoVenda: description: Detalhe de serviço de ponto de venda allOf: – #/definitions/detalheGeral – type: object required: – idCorrespondente – descricaoCorrespondente – idOperadora – descricaoOperadora properties: idCorrespondente: type: integer format: int64 description: Identificador do correspondente bancário descricaoCorrespondente: type: string description: Descrição do correspondente bancário idOperadora: type: integer format: int64 description: Identificador da operadora de telefonia descricaoOperadora: type: string description: Descrição da operadora de telefonia detalheComissao: description: Detalhe de comissão allOf: – #/definitions/detalheGeral – type: object required: – idRepresentante – descricaoRepresentante – sequenciaComissao – observacao – idAssessoriaCobranca – descricaoAssessoriaCobranca – idFaseCobranca – descricaoFaseCobranca – naturezaComissao – idTransacao – descricaoTransacao properties: idRepresentante: type: integer format: int64 description: Identificador do representante descricaoRepresentante: type: string description: Descrição do representante sequenciaComissao: type: integer format: int64 description: Sequência da comissão observacao: type: string description: Observação idAssessoriaCobranca: type: integer format: int64 description: Identificador da assessoria de cobrança descricaoAssessoriaCobranca: type: string description: Descrição da assessoria de cobrança idFaseCobranca: type: integer format: int64 description: Identificador da fase de cobrança descricaoFaseCobranca: type: string description: Descrição da fase de cobrança naturezaComissao: type: string description: Natureza da comissão idTransacao: type: string description: Identificador da transação descricaoTransacao: type: string description: Descrição da transação detalheMovimentoDiverso: description: Detalhe de movimento diverso allOf: – #/definitions/detalheGeral – type: object required: – numeroMovimento – observacao – idFormaPagamento – descricaoFormaPagamento – idNaturezaGastos – descricaoNaturezaGastos properties: numeroMovimento: type: integer format: int64 description: Número do movimento observacao: type: string description: Observação idFormaPagamento: type: integer format: int64 description: Identificador da forma de pagamento descricaoFormaPagamento: type: string description: Descrição da forma de pagamento idNaturezaGastos: type: integer format: int64 description: Identificador da natureza de gastos descricaoNaturezaGastos: type: string description: Descrição da natureza de gastos detalheOrcamentaria: description: Representa os detalhes da visão orçamentária allOf: – #/definitions/detalheGeral – type: object properties: idContaFinanceira: type: integer format: int64 description: Id da conta financeira codigoContaFinanceira: type: integer format: int64 description: Código de negócio da conta financeira idFormaPagamento: type: integer format: int64 description: Id da conta financeira codigoFormaPagamento: type: integer format: int64 description: Código de negócio da conta financeira descricaoOrigem: type: string description: Descrição Origem composicaoValorLiquidoTituloReceber: description: Composição do valor líquido de título a receber type: object required: – valorAberto – valorJuros – valorMulta – valorCorrecao – valorDescontos – valorEncargos – valorOutrosAcrescimos – valorOutrosDescontos – valorImpostoRenda – valorCOFINS – valorPIS – valorCSLL – valorOutrasRetencoes – valorLiquido – valorOriginal – valorMovimentoBaixa properties: valorAberto: type: string description: Valor aberto valorJuros: type: string description: Valor de juros valorMulta: type: string description: Valor de multa valorCorrecao: type: string description: Valor de correção monetária valorDescontos: type: string description: Valor de descontos valorEncargos: type: string description: Valor de encargos valorOutrosAcrescimos: type: string description: Valor de outros acréscimos valorOutrosDescontos: type: string description: Valor de outros descontos valorImpostoRenda: type: string description: Valor de imposto de renda valorCOFINS: type: string description: Valor de COFINS valorPIS: type: string description: Valor de PIS valorCSLL: type: string description: Valor de CSLL valorOutrasRetencoes: type: string description: Valor de outras retenções valorLiquido: type: string description: Valor líquido calculado valorOriginal: type: string description: Valor original do título valorMovimentoBaixa: type: string description: Valor do movimento de baixa composicaoValorLiquidoTituloPagar: description: Composição do valor líquido de título a pagar type: object required: – valorAberto – valorJuros – valorMulta – valorCorrecao – valorDescontos – valorEncargos – valorOutrosAcrescimos – valorOutrosDescontos – valorImpostoRenda – valorCOFINS – valorPIS – valorCSLL – valorOutrasRetencoes – valorLiquido – valorOriginal – valorMovimentoBaixa properties: valorAberto: type: string description: Valor aberto valorJuros: type: string description: Valor de juros valorMulta: type: string description: Valor de multa valorCorrecao: type: string description: Valor de correção monetária valorDescontos: type: string description: Valor de descontos valorEncargos: type: string description: Valor de encargos valorOutrosAcrescimos: type: string description: Valor de outros acréscimos valorOutrosDescontos: type: string description: Valor de outros descontos valorImpostoRenda: type: string description: Valor de imposto de renda valorCOFINS: type: string description: Valor de COFINS valorPIS: type: string description: Valor de PIS valorCSLL: type: string description: Valor de CSLL valorOutrasRetencoes: type: string description: Valor de outras retenções valorLiquido: type: string description: Valor líquido calculado valorOriginal: type: string description: Valor original do título valorMovimentoBaixa: type: string description: Valor do movimento de baixa grupoTitulos: description: Grupo de títulos com total type: object required: – nome – total properties: nome: type: string description: Nome do grupo total: type: string description: Total do grupo cliente: description: Dados do cliente type: object required: – id – nome properties: id: type: integer format: int64 description: Identificador do cliente nome: type: string description: Nome do cliente tituloReceber: description: Título a receber type: object required: – id – empresa – filial – tipoTitulo – cliente – transacaoEntrada – numero_titulo – moeda – valor_original – valor_aberto – dataOriginal – dataUtil – dataFloatAtrasoPrazo – observacao – portador – carteira – formaPagamento – grupoConta – situacao – naturezaGasto properties: id: type: integer format: int64 description: Identificador do título empresa: type: object allOf: – #/definitions/empresa description: Empresa do título filial: type: object allOf: – #/definitions/filial description: Filial do título tipoTitulo: type: object allOf: – #/definitions/tipoTitulo description: Tipo do título cliente: type: object allOf: – #/definitions/cliente description: Cliente do título transacaoEntrada: type: object allOf: – #/definitions/transacao description: Transação de entrada numero_titulo: type: string description: Número do título moeda: type: object allOf: – #/definitions/moeda description: Moeda do título valor_original: type: string description: Valor original valor_aberto: type: string description: Valor aberto dataOriginal: type: string description: Data original de vencimento dataUtil: type: string description: Data útil calculada dataFloatAtrasoPrazo: type: string description: Data com float, atraso e prazo observacao: type: string description: Observação do título portador: type: object allOf: – #/definitions/portador description: Portador do título carteira: type: object allOf: – #/definitions/carteira description: Carteira do título formaPagamento: type: object allOf: – #/definitions/formaPagamento description: Forma de pagamento grupoConta: type: object allOf: – #/definitions/grupoContas description: Grupo de contas situacao: type: object allOf: – #/definitions/situacaoTitulo description: Situação do título naturezaGasto: type: object allOf: – #/definitions/naturezaGastos description: Natureza de gasto empresa: description: Dados da empresa type: object required: – id – nomeFantasia – siglaMoeda properties: id: type: integer format: int64 description: Identificador da empresa nomeFantasia: type: string description: Nome fantasia siglaMoeda: type: string description: Sigla da moeda da empresa agrupamentoFilial: description: Agrupamento de filiais type: object required: – id – empresa – codigo – descricao properties: id: type: integer format: int64 description: Identificador do agrupamento empresa: type: object allOf: – #/definitions/empresa description: Empresa do agrupamento codigo: type: integer format: int64 description: Código do agrupamento descricao: type: string description: Descrição do agrupamento filial: description: Dados da filial type: object required: – id – empresaId – codigoFilial – agrupamento – nome – fantasia – cidade – estado properties: id: type: integer format: int64 description: Identificador da filial empresaId: type: object allOf: – #/definitions/empresa description: Empresa da filial codigoFilial: type: integer format: int64 description: Código da filial agrupamento: type: object allOf: – #/definitions/agrupamentoFilial description: Agrupamento da filial nome: type: string description: Nome da filial fantasia: type: string description: Nome fantasia da filial cidade: type: string description: Cidade da filial estado: type: string description: Estado da filial tipoTitulo: description: Tipo de título type: object required: – id – descricao – descricaoTipoSomaReceber – descricaoTipoSomaPagar – aplicacaoTipo – descricaoAplicacaoTipo – descricaoSituacao properties: id: type: string description: Identificador do tipo descricao: type: string description: Descrição do tipo descricaoTipoSomaReceber: type: string description: Descrição do tipo soma a receber descricaoTipoSomaPagar: type: string description: Descrição do tipo soma a pagar aplicacaoTipo: type: string allOf: – #/definitions/aplicacaoFinanceiro description: Aplicação do tipo descricaoAplicacaoTipo: type: string description: Descrição da aplicação descricaoSituacao: type: string description: Descrição da situação transacao: description: Transação financeira type: object required: – id – empresa – transacao – nome – modulo – descricaoModulo properties: id: type: integer format: int64 description: Identificador da transação empresa: type: object allOf: – #/definitions/empresa description: Empresa da transação transacao: type: string description: Código da transação nome: type: string description: Nome da transação modulo: type: string description: Módulo da transação descricaoModulo: type: string description: Descrição do módulo grupoContas: description: Grupo de contas type: object required: – id – descricao – aplicacaoGrupo – descricaoAplicacaoGrupo – descricaoSituacao properties: id: type: string description: Identificador do grupo descricao: type: string description: Descrição do grupo aplicacaoGrupo: type: string allOf: – #/definitions/aplicacaoFinanceiro description: Aplicação do grupo descricaoAplicacaoGrupo: type: string description: Descrição da aplicação descricaoSituacao: type: string description: Descrição da situação condicaoPagamento: description: Condição de pagamento type: object required: – id – empresa – condicao – descricaoCondicao – aplicacao – descricaoAplicacao – situacao properties: id: type: integer format: int64 description: Identificador da condição empresa: type: object allOf: – #/definitions/empresa description: Empresa da condição condicao: type: string description: Código da condição descricaoCondicao: type: string description: Descrição da condição aplicacao: type: string description: Aplicação descricaoAplicacao: type: string description: Descrição da aplicação situacao: type: string description: Situação formaPagamento: description: Forma de pagamento type: object required: – id – empresa – formaPagamento – descricao – tipo – descricaoSituacao properties: id: type: integer format: int64 description: Identificador empresa: type: object allOf: – #/definitions/empresa description: Empresa formaPagamento: type: integer format: int64 description: Código da forma de pagamento descricao: type: string description: Descrição tipo: type: string description: Tipo da forma descricaoSituacao: type: string description: Descrição da situação moeda: description: Moeda type: object required: – id – nome – sigla properties: id: type: string description: Identificador da moeda nome: type: string description: Nome da moeda sigla: type: string description: Sigla da moeda idG7: type: integer format: int64 description: Identificador legado G7 banco: description: Banco type: object required: – id – nome – correspondente properties: id: type: string description: Identificador do banco nome: type: string description: Nome do banco correspondente: type: string description: Indicativo de correspondente agencia: description: Agência bancária type: object required: – id – banco – agencia – nome properties: id: type: integer format: int64 description: Identificador da agência banco: type: object allOf: – #/definitions/banco description: Banco da agência agencia: type: string description: Número da agência nome: type: string description: Nome da agência tipoConta: description: Tipo de conta interna type: object required: – id – descricao – aplicacao properties: id: type: string description: Identificador do tipo descricao: type: string description: Descrição do tipo aplicacao: type: integer format: int64 description: Aplicação contaInterna: description: Conta interna type: object required: – id – empresa – contaInterna – descricao – banco – agencia – tipoConta – moeda – numeroContaBancaria – floatBancario properties: id: type: integer format: int64 description: Identificador da conta empresa: type: object allOf: – #/definitions/empresa description: Empresa da conta contaInterna: type: string description: Código da conta interna descricao: type: string description: Descrição da conta banco: type: object allOf: – #/definitions/banco description: Banco da conta agencia: type: object allOf: – #/definitions/agencia description: Agência da conta tipoConta: type: object allOf: – #/definitions/tipoConta description: Tipo da conta moeda: type: object allOf: – #/definitions/moeda description: Moeda da conta numeroContaBancaria: type: string description: Número da conta bancária floatBancario: type: integer format: int64 description: Float bancário em dias situacao: type: string description: Situação da conta portador: description: Portador type: object required: – id – empresa – portador – descricao – floatBancario – descricaoContaInterna properties: id: type: integer format: int64 description: Identificador do portador empresa: type: object allOf: – #/definitions/empresa description: Empresa do portador portador: type: string description: Código do portador descricao: type: string description: Descrição do portador floatBancario: type: integer format: int64 description: Float bancário em dias descricaoContaInterna: type: string description: Descrição da conta interna associada carteira: description: Carteira type: object required: – id – descricao – indicativo properties: id: type: string description: Identificador da carteira descricao: type: string description: Descrição da carteira indicativo: type: string description: Indicativo da carteira naturezaGastos: description: Natureza de gastos type: object required: – id – empresa – naturezaGasto – descricao – tipoNatureza properties: id: type: integer format: int64 description: Identificador empresa: type: object allOf: – #/definitions/empresa description: Empresa naturezaGasto: type: integer format: int64 description: Código da natureza descricao: type: string description: Descrição tipoNatureza: type: string description: Tipo da natureza motivo: description: Motivo type: object required: – id – descricao – aplicacao – descricaoAplicacao properties: id: type: integer format: int64 description: Identificador do motivo descricao: type: string description: Descrição do motivo aplicacao: type: integer format: int64 description: Aplicação descricaoAplicacao: type: string description: Descrição da aplicação limiteCredito: description: Limite de crédito type: object required: – utilizaLimite properties: utilizaLimite: type: boolean description: Indica se utiliza limite de crédito moedaVisao: description: Moeda utilizada na visão do fluxo type: object required: – moedaId – cotacao – percentual properties: moedaId: type: string description: Identificador da moeda cotacao: type: number format: double description: Cotação da moeda percentual: type: number format: double description: Percentual aplicado grafico: description: Configuração do gráfico type: object required: – geraGrafico – niveis properties: geraGrafico: type: boolean description: Indica se gera gráfico niveis: type: string allOf: – #/definitions/impressaoGrafico description: Formato de impressão do gráfico saldoContaInterna: description: Saldo da conta interna type: object required: – tipoData properties: tipoData: type: string allOf: – #/definitions/tipoDataSaldo description: Tipo de data para busca do saldo contaInternaId: type: array items: type: integer format: int64 description: Lista de contas internas tipoContaId: type: array items: type: string description: Lista de tipos de conta saldoValorDigitado: description: Saldo digitado manualmente type: object properties: valor: type: string description: Valor do saldo saldoInicial: description: Configuração do saldo inicial type: object required: – tipoSaldo properties: tipoSaldo: type: string allOf: – #/definitions/origemSaldo description: Tipo de saldo (valor, conta interna ou extrato) saldoContaInterna: type: object allOf: – #/definitions/saldoContaInterna description: Saldo por conta interna saldoValorDigitado: type: object allOf: – #/definitions/saldoValorDigitado description: Saldo por valor digitado saldoExtratoBancario: type: object allOf: – #/definitions/saldoExtratoBancario description: Saldo por extrato bancário saldoExtratoBancario: description: Saldo do extrato bancário type: object required: – filtroExtrato properties: filtroExtrato: type: string allOf: – #/definitions/filtroExtratos description: Filtro de extratos contaInternaId: type: array items: type: integer format: int64 description: Lista de contas internas tipoContaId: type: array items: type: string description: Lista de tipos de conta situacaoTitulo: description: Situação do título type: object required: – id – descricao properties: id: type: string description: Identificador da situação descricao: type: string description: Descrição da situação simulacaoImpostos: description: Simulação de impostos type: object required: – considera properties: considera: type: boolean description: Indica se considera impostos percentual: type: number format: double description: Percentual de impostos impostos: type: array items: type: string allOf: – #/definitions/impostos description: Lista de impostos considerados composicaoDistribuicao: description: Composição de distribuição de vencidos type: object required: – periodoInicial – periodoFinal – percentual properties: periodoInicial: type: integer format: int64 description: Período inicial periodoFinal: type: integer format: int64 description: Período final percentual: type: number format: double description: Percentual de distribuição distribuicaoVencidos: description: Distribuição de vencidos type: object required: – id – tipoDistribuicao properties: id: type: integer format: int64 description: Identificador da distribuição tipoDistribuicao: type: string allOf: – #/definitions/tipoDistribuicao description: Tipo de distribuição distribuicao: type: array items: type: object allOf: – #/definitions/composicaoDistribuicao description: Composição da distribuição parametrosBase: description: Parâmetros base para rotinas do fluxo discriminator: _discriminator type: object required: – considera – _discriminator properties: considera: type: boolean description: Indica se considera esta rotina percentualEfetivos: type: number format: double description: Percentual aplicado sobre efetivos percentualPrevistos: type: number format: double description: Percentual aplicado sobre previstos _discriminator: type: string description: parametrosContasReceber: description: Parâmetros de contas a receber allOf: – #/definitions/parametrosBase – type: object properties: categoria: type: string allOf: – #/definitions/categoriaTitulos description: Categoria dos títulos buscaVencimentoContasReceber: type: array items: type: string allOf: – #/definitions/buscaVencimentoContasReceber description: Critérios de busca de vencimento calculoFinanceiroTitulos: type: array items: type: string allOf: – #/definitions/calculoFinanceiroTitulos description: Cálculos financeiros a considerar tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: Tipo de vencimento situacaoTitulo: type: array items: type: string description: Filtro de situação do título tipoTitulo: type: array items: type: string description: Filtro de tipo de título transacaoEntrada: type: array items: type: integer format: int64 description: Filtro de transação de entrada transacaoBaixa: type: array items: type: integer format: int64 description: Filtro de transação de baixa grupo: type: array items: type: string description: Filtro de grupo formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento portador: type: array items: type: integer format: int64 description: Filtro de portador carteira: type: array items: type: string description: Filtro de carteira naturezaGastos: type: array items: type: integer format: int64 description: Filtro de natureza de gastos moeda: type: array items: type: string description: Filtro de moeda tipoConta: type: array items: type: string description: Filtro de tipo de conta contaInterna: type: array items: type: integer format: int64 description: Filtro de conta interna simulacaoImpostos: type: object allOf: – #/definitions/simulacaoImpostos description: Simulação de impostos tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: Tipo de busca de movimento considerarDerivativos: type: boolean description: Indica se considera derivativos produtoBancario: type: array items: type: integer format: int64 description: Filtro de produto bancário distribuirVencidos: description: Parâmetros de distribuição de vencidos type: object required: – considera properties: considera: type: boolean description: Indica se considera distribuição cadastroDistribuicaoVencidosId: type: integer format: int64 description: Identificador do cadastro de distribuição categoria: type: string allOf: – #/definitions/categoriaTitulos description: Categoria dos títulos percentualLimite: type: number format: double description: Percentual limite utilizaMesmoFiltro: type: boolean description: Indica se utiliza o mesmo filtro periodoInicial: type: string format: date description: Período inicial periodoFinal: type: string format: date description: Período final calculoFinanceiroTitulos: type: array items: type: string allOf: – #/definitions/calculoFinanceiroTitulos description: Cálculos financeiros tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: Tipo de vencimento situacaoTitulo: type: array items: type: string description: Filtro de situação do título tipoTitulo: type: array items: type: string description: Filtro de tipo de título transacaoEntrada: type: array items: type: integer format: int64 description: Filtro de transação de entrada grupo: type: array items: type: string description: Filtro de grupo formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento portador: type: array items: type: integer format: int64 description: Filtro de portador carteira: type: array items: type: string description: Filtro de carteira naturezaGastos: type: array items: type: integer format: int64 description: Filtro de natureza de gastos moeda: type: array items: type: string description: Filtro de moeda consideraNaoAprovados: type: boolean description: Indica se considera não aprovados parametrosPedido: description: Parâmetros de pedido allOf: – #/definitions/parametrosBase – type: object properties: tipoParcela: type: string allOf: – #/definitions/tipoParcela description: Tipo de parcela transacaoProduto: type: array items: type: integer format: int64 description: Filtro de transação de produto transacaoServico: type: array items: type: integer format: int64 description: Filtro de transação de serviço condicaoPagamento: type: array items: type: integer format: int64 description: Filtro de condição de pagamento formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento moeda: type: array items: type: string description: Filtro de moeda situacao: type: array items: type: string allOf: – #/definitions/situacaoComercial description: Filtro de situação comercial parametrosContratoVenda: description: Parâmetros de contrato de venda allOf: – #/definitions/parametrosBase – type: object properties: transacaoProduto: type: array items: type: integer format: int64 description: Filtro de transação de produto transacaoServico: type: array items: type: integer format: int64 description: Filtro de transação de serviço tipoContrato: type: array items: type: string allOf: – #/definitions/tipoContrato description: Filtro de tipo de contrato condicaoPagamento: type: array items: type: integer format: int64 description: Filtro de condição de pagamento formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento moeda: type: array items: type: string description: Filtro de moeda motivo: type: array items: type: integer format: int64 description: Filtro de motivo criterioFaturamento: type: string allOf: – #/definitions/criterioFaturamento description: Critério de faturamento parametrosOrdemCompra: description: Parâmetros de ordem de compra allOf: – #/definitions/parametrosBase – type: object properties: transacaoProduto: type: array items: type: integer format: int64 description: Filtro de transação de produto transacaoServico: type: array items: type: integer format: int64 description: Filtro de transação de serviço situacao: type: array items: type: string allOf: – #/definitions/situacaoComercial description: Filtro de situação comercial condicaoPagamento: type: array items: type: integer format: int64 description: Filtro de condição de pagamento formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento moeda: type: array items: type: string description: Filtro de moeda tipoParcela: type: string allOf: – #/definitions/tipoParcela description: Tipo de parcela parametrosContratoCompra: description: Parâmetros de contrato de compra allOf: – #/definitions/parametrosBase – type: object properties: transacaoProduto: type: array items: type: integer format: int64 description: Filtro de transação de produto transacaoServico: type: array items: type: integer format: int64 description: Filtro de transação de serviço tipoContrato: type: array items: type: string allOf: – #/definitions/tipoContrato description: Filtro de tipo de contrato condicaoPagamento: type: array items: type: integer format: int64 description: Filtro de condição de pagamento formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento moeda: type: array items: type: string description: Filtro de moeda motivo: type: array items: type: integer format: int64 description: Filtro de motivo parametrosContasPagar: description: Parâmetros de contas a pagar allOf: – #/definitions/parametrosBase – type: object properties: categoria: type: string allOf: – #/definitions/categoriaTitulos description: Categoria dos títulos calculoFinanceiroTitulos: type: array items: type: string allOf: – #/definitions/calculoFinanceiroTitulos description: Cálculos financeiros tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: Tipo de vencimento situacaoTitulo: type: array items: type: string description: Filtro de situação do título tipoTitulo: type: array items: type: string description: Filtro de tipo de título transacaoEntrada: type: array items: type: integer format: int64 description: Filtro de transação de entrada transacaoBaixa: type: array items: type: integer format: int64 description: Filtro de transação de baixa grupo: type: array items: type: string description: Filtro de grupo formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento portador: type: array items: type: integer format: int64 description: Filtro de portador carteira: type: array items: type: string description: Filtro de carteira naturezaGastos: type: array items: type: integer format: int64 description: Filtro de natureza de gastos moeda: type: array items: type: string description: Filtro de moeda consideraNaoAprovados: type: boolean description: Indica se considera não aprovados simulacaoImpostos: type: object allOf: – #/definitions/simulacaoImpostos description: Simulação de impostos tipoConta: type: array items: type: string description: Filtro de tipo de conta contaInterna: type: array items: type: integer format: int64 description: Filtro de conta interna tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: Tipo de busca de movimento consideraVencidos: type: boolean description: Indica se considera vencidos considerarDerivativos: type: boolean description: Indica se considera derivativos produtoBancario: type: array items: type: integer format: int64 description: Filtro de produto bancário parametrosExtratoBancario: description: Parâmetros de extrato bancário allOf: – #/definitions/parametrosBase – type: object properties: filtroExtratos: type: string allOf: – #/definitions/filtroExtratos description: Filtro de extratos tipoConta: type: array items: type: string description: Filtro de tipo de conta contaInterna: type: array items: type: integer format: int64 description: Filtro de conta interna tipoDocumento: description: Tipo de documento type: object required: – id – empresa – documento – descricao properties: id: type: integer format: int64 description: Identificador do tipo de documento empresa: type: object allOf: – #/definitions/empresa description: Empresa do documento documento: type: string description: Código do documento descricao: type: string description: Descrição do documento parametrosTesouraria: description: Parâmetros de tesouraria allOf: – #/definitions/parametrosBase – type: object properties: transacao: type: array items: type: integer format: int64 description: Filtro de transação tipoConta: type: array items: type: string description: Filtro de tipo de conta contaInterna: type: array items: type: integer format: int64 description: Filtro de conta interna tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: Tipo de busca de movimento origemTesouraria: type: array items: type: string allOf: – #/definitions/origemTesouraria description: Filtro de origem de tesouraria naturezaGastos: type: array items: type: integer format: int64 description: Filtro de natureza de gastos consideraBloqueado: type: boolean description: Indica se considera movimentos bloqueados tipoDocumento: type: array items: type: integer format: int64 description: Filtro de tipo de documento situacaoProjeto: description: Situação do projeto type: object required: – id – empresa – situacao – descricao properties: id: type: integer format: int64 description: Identificador da situação empresa: type: object allOf: – #/definitions/empresa description: Empresa situacao: type: string description: Código da situação descricao: type: string description: Descrição da situação projeto: description: Projeto type: object required: – id – empresa – projeto – nome – abreviatura – situacao – natureza – controlaMes properties: id: type: integer format: int64 description: Identificador do projeto empresa: type: object allOf: – #/definitions/empresa description: Empresa do projeto projeto: type: integer format: int64 description: Número do projeto nome: type: string description: Nome do projeto abreviatura: type: string description: Abreviatura do projeto situacao: type: object allOf: – #/definitions/situacaoProjeto description: Situação do projeto natureza: type: string description: Natureza do projeto (crédito/débito) controlaMes: type: string description: Indica se controla por mês faseProjeto: description: Fase do projeto type: object required: – id – empresa – projetoId – fase – descricao – abreviatura – natureza properties: id: type: integer format: int64 description: Identificador da fase empresa: type: object allOf: – #/definitions/empresa description: Empresa projetoId: type: object allOf: – #/definitions/projeto description: Projeto da fase fase: type: integer format: int64 description: Número da fase descricao: type: string description: Descrição da fase abreviatura: type: string description: Abreviatura da fase natureza: type: string description: Natureza da fase contaFinanceira: description: Conta financeira type: object required: – id – contaFinanceira – empresa – abreviatura – classificacao – mascara – natureza properties: id: type: integer format: int64 description: Identificador da conta contaFinanceira: type: integer format: int64 description: Código da conta financeira empresa: type: object allOf: – #/definitions/empresa description: Empresa da conta abreviatura: type: string description: Abreviatura da conta classificacao: type: string description: Classificação hierárquica mascara: type: string description: Máscara de exibição natureza: type: string description: Natureza (crédito/débito) contaContabil: description: Conta contábil type: object required: – id – contacontabil – empresa – abreviatura – classificacao – mascara – natureza properties: id: type: integer format: int64 description: Identificador da conta contacontabil: type: integer format: int64 description: Código da conta contábil empresa: type: object allOf: – #/definitions/empresa description: Empresa da conta abreviatura: type: string description: Abreviatura da conta classificacao: type: string description: Classificação hierárquica mascara: type: string description: Máscara de exibição natureza: type: string description: Natureza (crédito/débito) centroCusto: description: Centro de custo type: object required: – id – centroCusto – empresa – abreviatura – classificacao – mascara properties: id: type: integer format: int64 description: Identificador do centro de custo centroCusto: type: string description: Código do centro de custo empresa: type: object allOf: – #/definitions/empresa description: Empresa abreviatura: type: string description: Abreviatura classificacao: type: string description: Classificação hierárquica mascara: type: string description: Máscara de exibição assessoriaCobranca: description: Assessoria de cobrança type: object required: – id – empresa – assessoria – descricao properties: id: type: integer format: int64 description: Identificador da assessoria empresa: type: object allOf: – #/definitions/empresa description: Empresa assessoria: type: integer format: int64 description: Código da assessoria descricao: type: string description: Descrição da assessoria faseCobranca: description: Fase de cobrança type: object required: – id – empresa – assessoria – fase – descricao properties: id: type: integer format: int64 description: Identificador da fase empresa: type: object allOf: – #/definitions/empresa description: Empresa assessoria: type: object allOf: – #/definitions/assessoriaCobranca description: Assessoria de cobrança fase: type: integer format: int64 description: Número da fase descricao: type: string description: Descrição da fase parametrosBaseOrcada: description: Parâmetros da base orçada allOf: – #/definitions/parametrosBase – type: object properties: prazoMedio: type: integer format: int64 description: Prazo médio em dias origemOrcamento: type: string allOf: – #/definitions/origemOrcamento description: Origem do orçamento origemOrcamentoCentroCustos: type: string allOf: – #/definitions/origemOrcamentoCentroCustos description: Origem do orçamento por centro de custos origemOrcamentoProjetos: type: string allOf: – #/definitions/origemOrcamentoProjetos description: Origem do orçamento por projetos origemOrcamentoContaFinanceira: type: string allOf: – #/definitions/origemOrcamentoContaFinanceira description: Origem do orçamento por conta financeira periodoInicial: type: string format: date description: Período inicial periodoFinal: type: string format: date description: Período final projeto: type: array items: type: integer format: int64 description: Filtro de projeto faseProjeto: type: array items: type: integer format: int64 description: Filtro de fase de projeto contaFinanceira: type: array items: type: integer format: int64 description: Filtro de conta financeira contaContabil: type: array items: type: integer format: int64 description: Filtro de conta contábil centroCusto: type: array items: type: integer format: int64 description: Filtro de centro de custo formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento parametrosComissao: description: Parâmetros de comissão allOf: – #/definitions/parametrosBase – type: object properties: transacao: type: array items: type: integer format: int64 description: Filtro de transação assessoriaCobranca: type: array items: type: integer format: int64 description: Filtro de assessoria de cobrança faseCobranca: type: array items: type: integer format: int64 description: Filtro de fase de cobrança dataPagamento: type: string format: date description: Data de pagamento percentualSimuladas: type: number format: double description: Percentual de comissões simuladas parametrosMovimentosDiversos: description: Parâmetros de movimentos diversos allOf: – #/definitions/parametrosBase – type: object properties: formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento naturezaGastos: type: array items: type: integer format: int64 description: Filtro de natureza de gastos projeto: type: array items: type: integer format: int64 description: Filtro de projeto faseProjeto: type: array items: type: integer format: int64 description: Filtro de fase de projeto contaFinanceira: type: array items: type: integer format: int64 description: Filtro de conta financeira contaContabil: type: array items: type: integer format: int64 description: Filtro de conta contábil centroCusto: type: array items: type: integer format: int64 description: Filtro de centro de custo moeda: type: array items: type: string description: Filtro de moeda produtoBancario: description: Produto bancário type: object required: – id – empresa – numero – descricao – geraDiferenca – tipoProduto properties: id: type: integer format: int64 description: Identificador do produto empresa: type: object allOf: – #/definitions/empresa description: Empresa numero: type: integer format: int64 description: Número do produto descricao: type: string description: Descrição do produto geraDiferenca: type: string description: Indica se gera diferença tipoProduto: type: integer format: int64 description: Tipo do produto calculoContratoFinanceiro: description: Cálculo de contrato financeiro type: object required: – id – empresa – numero – descricao properties: id: type: integer format: int64 description: Identificador do cálculo empresa: type: object allOf: – #/definitions/empresa description: Empresa numero: type: integer format: int64 description: Número do cálculo descricao: type: string description: Descrição do cálculo parametrosAplicacaoFinanceira: description: Parâmetros de aplicação financeira type: object required: – considera properties: considera: type: boolean description: Indica se considera aplicação financeira percentual: type: number format: double description: Percentual aplicado produtoBancario: type: array items: type: integer format: int64 description: Filtro de produto bancário calculoContrato: type: array items: type: integer format: int64 description: Filtro de cálculo de contrato tipoConta: type: array items: type: string description: Filtro de tipo de conta contaInterna: type: array items: type: integer format: int64 description: Filtro de conta interna parametrosEmprestimo: description: Parâmetros de empréstimo allOf: – #/definitions/parametrosBase – type: object properties: produtoBancario: type: array items: type: integer format: int64 description: Filtro de produto bancário calculoContrato: type: array items: type: integer format: int64 description: Filtro de cálculo de contrato contaInterna: type: array items: type: integer format: int64 description: Filtro de conta interna situacaoTitulo: type: array items: type: string description: Filtro de situação do título tipoVencimentoTitulo: type: string allOf: – #/definitions/tipoVencimentoTitulo description: Tipo de vencimento tipoTitulo: type: array items: type: string description: Filtro de tipo de título transacao: type: array items: type: integer format: int64 description: Filtro de transação grupo: type: array items: type: string description: Filtro de grupo formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento portador: type: array items: type: integer format: int64 description: Filtro de portador carteira: type: array items: type: string description: Filtro de carteira naturezaGastos: type: array items: type: integer format: int64 description: Filtro de natureza de gastos moeda: type: array items: type: string description: Filtro de moeda produtoCorrespondenteBancario: description: Produto de correspondente bancário type: object required: – id – banco – produto – descricaoProduto properties: id: type: integer format: int64 description: Identificador do produto banco: type: object allOf: – #/definitions/banco description: Banco do correspondente produto: type: integer format: int64 description: Número do produto descricaoProduto: type: string description: Descrição do produto operadorTelefonia: description: Operadora de telefonia type: object required: – id – empresa – operadora – nome properties: id: type: integer format: int64 description: Identificador da operadora empresa: type: object allOf: – #/definitions/empresa description: Empresa operadora: type: integer format: int64 description: Código da operadora nome: type: string description: Nome da operadora parametrosServicoPontoVenda: description: Parâmetros de serviço de ponto de venda allOf: – #/definitions/parametrosBase – type: object properties: tipoRecebimento: type: string allOf: – #/definitions/tipoRecebimento description: Tipo de recebimento correspondenteBancario: type: array items: type: string description: Filtro de correspondente bancário produtoCorrespondente: type: array items: type: integer format: int64 description: Filtro de produto do correspondente operadoras: type: array items: type: integer format: int64 description: Filtro de operadoras parametrosBaseHistorica: description: Parâmetros de base histórica allOf: – #/definitions/parametrosBase – type: object properties: tipoBuscaBaseHistorica: type: string allOf: – #/definitions/tipoBuscaBaseHistorica description: Tipo de busca da base histórica periodoInicial: type: string format: date description: Período inicial periodoFinal: type: string format: date description: Período final tipoTitulo: type: array items: type: string description: Filtro de tipo de título grupo: type: array items: type: string description: Filtro de grupo formaPagamento: type: array items: type: integer format: int64 description: Filtro de forma de pagamento portador: type: array items: type: integer format: int64 description: Filtro de portador carteira: type: array items: type: string description: Filtro de carteira transacaoEntrada: type: array items: type: integer format: int64 description: Filtro de transação de entrada transacaoBaixa: type: array items: type: integer format: int64 description: Filtro de transação de baixa situacaoTitulo: type: array items: type: string description: Filtro de situação do título buscaVencimentoContasReceber: type: array items: type: string allOf: – #/definitions/buscaVencimentoContasReceber description: Critérios de busca de vencimento tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: Tipo de vencimento tipoValor: type: string allOf: – #/definitions/tipoValor description: Tipo de valor transacao: type: array items: type: integer format: int64 description: Filtro de transação tipoConta: type: array items: type: string description: Filtro de tipo de conta contaInterna: type: array items: type: integer format: int64 description: Filtro de conta interna tipoDocumento: type: array items: type: integer format: int64 description: Filtro de tipo de documento naturezaGastos: type: array items: type: integer format: int64 description: Filtro de natureza de gastos moeda: type: array items: type: string description: Filtro de moeda tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: Tipo de busca de movimento origemTesouraria: type: array items: type: string allOf: – #/definitions/origemTesouraria description: Filtro de origem de tesouraria filtroExtratos: type: string allOf: – #/definitions/filtroExtratos description: Filtro de extratos consultaInformacoesRapida: description: Consulta rápida de informações type: object required: – id – descricao properties: id: type: integer format: int64 description: Identificador descricao: type: string description: Descrição parametrizacao: description: Parametrização completa do fluxo de caixa type: object required: – tipoVisao – periodicidade – agrupamento properties: idTemplate: type: integer format: int64 description: Identificador do template descricaoVisao: type: string description: Descrição da visão tipoVisao: type: string allOf: – #/definitions/tipoVisao description: Tipo de visão periodicidade: type: string allOf: – #/definitions/periodicidade description: Periodicidade periodoFluxo: type: string allOf: – #/definitions/periodoFluxo description: Período do fluxo inicioPeriodoFluxoOriginal: type: string format: date description: Início do período original inicioPeriodoFluxo: type: string format: date description: Início do período fimPeriodoFluxo: type: string format: date description: Fim do período dataBase: type: string format: date description: Data base considerarDiaNaoUtil: type: boolean description: Indica se considera dia não útil agrupamento: type: string allOf: – #/definitions/agrupamento description: Tipo de agrupamento ordenacaoAgrupamento: type: string allOf: – #/definitions/ordenacaoAgrupamento description: Ordenação do agrupamento limiteCredito: type: object allOf: – #/definitions/limiteCredito description: Limite de crédito caixaMinimo: type: string description: Caixa mínimo somaCaixaLimite: type: boolean description: Indica se soma caixa com limite moeda: type: object allOf: – #/definitions/moedaVisao description: Moeda da visão empresa: type: array items: type: integer format: int64 description: Filtro de empresas agrupamentoFiliais: type: array items: type: integer format: int64 description: Filtro de agrupamentos de filiais filial: type: array items: type: integer format: int64 description: Filtro de filiais rotinas: type: array items: type: string allOf: – #/definitions/rotinaFluxo description: Rotinas consideradas siglaMoedaEmpresas: type: string description: Sigla da moeda das empresas percentualReceita: type: number format: double description: Percentual de receita percentualDespesa: type: number format: double description: Percentual de despesa origemRealizado: type: string allOf: – #/definitions/origemRealizado description: Origem do realizado buscarHistorico: type: string allOf: – #/definitions/baseHistorica description: Buscar histórico grafico: type: object allOf: – #/definitions/grafico description: Configuração de gráfico visualizarOrigem: type: boolean description: Indica se visualiza a origem saldoInicial: type: object allOf: – #/definitions/saldoInicial description: Saldo inicial consolidarPorEmpresa: type: boolean description: Indica se consolida por empresa visualizacaoNiveis: type: string allOf: – #/definitions/enumVisualizacaoNiveis description: Visualização de níveis visualizacaoNiveisSuperiores: type: string allOf: – #/definitions/enumVisualizacaoNiveis description: Visualização de níveis superiores pedido: type: object allOf: – #/definitions/parametrosPedido description: Parâmetros de pedido (receitas) contratoVenda: type: object allOf: – #/definitions/parametrosContratoVenda description: Parâmetros de contrato de venda (receitas) contasReceber: type: object allOf: – #/definitions/parametrosContasReceber description: Parâmetros de contas a receber (receitas) aplicacaoFinanceira: type: object allOf: – #/definitions/parametrosAplicacaoFinanceira description: Parâmetros de aplicação financeira (receitas) tesourariaReceita: type: object allOf: – #/definitions/parametrosTesouraria description: Parâmetros de tesouraria receita baseOrcadaReceita: type: object allOf: – #/definitions/parametrosBaseOrcada description: Parâmetros de base orçada receita movimentosDiversosReceita: type: object allOf: – #/definitions/parametrosMovimentosDiversos description: Parâmetros de movimentos diversos receita baseHistoricaReceita: type: object allOf: – #/definitions/parametrosBaseHistorica description: Parâmetros de base histórica receita distribuirVencidosReceber: type: object allOf: – #/definitions/distribuirVencidos description: Distribuição de vencidos a receber extratosBancariosReceita: type: object allOf: – #/definitions/parametrosExtratoBancario description: Parâmetros de extratos bancários receita ordemCompra: type: object allOf: – #/definitions/parametrosOrdemCompra description: Parâmetros de ordem de compra (despesas) contratoCompra: type: object allOf: – #/definitions/parametrosContratoCompra description: Parâmetros de contrato de compra (despesas) contasPagar: type: object allOf: – #/definitions/parametrosContasPagar description: Parâmetros de contas a pagar (despesas) comissao: type: object allOf: – #/definitions/parametrosComissao description: Parâmetros de comissão (despesas) emprestimo: type: object allOf: – #/definitions/parametrosEmprestimo description: Parâmetros de empréstimo (despesas) servicoPontoVenda: type: object allOf: – #/definitions/parametrosServicoPontoVenda description: Parâmetros de serviço ponto de venda (despesas) tesourariaDespesa: type: object allOf: – #/definitions/parametrosTesouraria description: Parâmetros de tesouraria despesa baseOrcadaDespesa: type: object allOf: – #/definitions/parametrosBaseOrcada description: Parâmetros de base orçada despesa movimentosDiversosDespesa: type: object allOf: – #/definitions/parametrosMovimentosDiversos description: Parâmetros de movimentos diversos despesa baseHistoricaDespesa: type: object allOf: – #/definitions/parametrosBaseHistorica description: Parâmetros de base histórica despesa distribuirVencidosPagar: type: object allOf: – #/definitions/distribuirVencidos description: Distribuição de vencidos a pagar mostrarNiveisSuperiores: type: boolean description: Indica se mostra níveis superiores criteriosBaseHistorica: type: object allOf: – #/definitions/criteriosBaseHistorica description: Critérios de base histórica extratosBancariosDespesa: type: object allOf: – #/definitions/parametrosExtratoBancario description: Parâmetros de extratos bancários despesa criteriosBaseHistorica: description: Critérios de base histórica type: object properties: divisao: type: string allOf: – #/definitions/divisaoBaseHistorica description: Divisão da base histórica templateId: type: integer format: int64 description: Identificador do template percentualSobre: type: boolean description: Indica se percentual sobre diaUtil: description: Dia útil type: object required: – nomeCampo – cep – data properties: nomeCampo: type: string description: Nome do campo cep: type: integer format: int64 description: CEP para cálculo data: type: string format: date description: Data a ser calculada itensDistribuicao: description: Itens de distribuição type: object required: – periodoInicial – periodoFinal – percentual properties: periodoInicial: type: integer format: int64 description: Período inicial periodoFinal: type: integer format: int64 description: Período final percentual: type: number format: double description: Percentual de distribuição caracteristicaRotina: description: Característica da rotina com percentual type: object required: – considera – rotina – percentual properties: considera: type: boolean description: Indica se considera a rotina rotina: type: string allOf: – #/definitions/rotinaAlterada description: Rotina alterada percentual: type: number format: double description: Percentual aplicado lancamentosAgrupamento: description: Lançamentos do agrupamento type: object required: – id – valor – observacao – readOnly properties: id: type: integer format: int64 description: Identificador do lançamento valor: type: string description: Valor do lançamento observacao: type: string description: Observação readOnly: type: boolean description: Indica se é somente leitura percentualAjustado: type: number format: double description: Percentual ajustado cadastroPercentuais: description: Cadastro de percentuais type: object required: – rateioId – data – percentual properties: rateioId: type: integer format: int64 description: Identificador do rateio data: type: string format: date description: Data do percentual percentual: type: string description: Valor do percentual templatePercentualResumido: description: Resumo do template de percentual type: object required: – id – descricao – periodicidade – agrupamento properties: id: type: integer format: int64 description: Identificador do template descricao: type: string description: Descrição do template periodicidade: type: string allOf: – #/definitions/periodicidade description: Periodicidade agrupamento: type: string allOf: – #/definitions/agrupamento description: Agrupamento filtroEmpresa: type: string description: Filtro de empresa usuarioGeracao: type: string description: Usuário que gerou usuarioAlteracao: type: string description: Usuário que alterou dataGeracao: type: string format: date-time description: Data de geração dataAlteracao: type: string format: date-time description: Data de alteração 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 recVisao: description: Record de visão do fluxo de caixa type: object required: – descricaoVisao – parametrizacao properties: id: type: integer format: int64 description: Identificador da visão descricaoVisao: type: string description: Descrição da visão favorita: type: boolean description: Indica se é favorita usuarioGeracao: type: string description: Usuário que gerou usuarioAlteracao: type: string description: Usuário que alterou dataGeracao: type: string format: date-time description: Data de geração dataAlteracao: type: string format: date-time description: Data de alteração parametrizacao: type: object allOf: – #/definitions/parametrizacao description: Parametrização da visão recMovimentoDiverso: description: Movimento diverso type: object required: – empresaId – filialId – dataMovimento – tipoMovimento – descricao – valor – visao – tipoAgrupamento properties: id: type: integer format: int64 description: Identificador do movimento empresaId: type: integer format: int64 description: Identificador da empresa filialId: type: integer format: int64 description: Identificador da filial dataMovimento: type: string format: date description: Data do movimento tipoMovimento: type: string allOf: – #/definitions/naturezaMovimento description: Tipo do movimento (crédito/débito) descricao: type: string description: Descrição do movimento valor: type: string description: Valor do movimento visao: type: string allOf: – #/definitions/tipoVisaoMovimentoDiverso description: Visão do movimento diverso tipoAgrupamento: type: array items: type: string allOf: – #/definitions/agrupamento minimum: 1 description: Tipos de agrupamento formaPagamentoId: type: array items: type: integer format: int64 description: Filtro de forma de pagamento naturezaGastosId: type: array items: type: integer format: int64 description: Filtro de natureza de gastos projetoId: type: array items: type: integer format: int64 description: Filtro de projeto faseProjetoId: type: array items: type: integer format: int64 description: Filtro de fase de projeto contaFinanceiraId: type: array items: type: integer format: int64 description: Filtro de conta financeira contaContabilId: type: array items: type: integer format: int64 description: Filtro de conta contábil centroCustosId: type: array items: type: integer format: int64 description: Filtro de centro de custos moedasId: type: array items: type: integer format: int64 description: Filtro de moedas dataAlteracao: type: string format: date-time description: Data de alteração recCriterioDistribuicaoVencidos: description: Critério de distribuição de vencidos type: object required: – descricao – tipoDistribuicao – itensDistribuicao properties: id: type: integer format: int64 description: Identificador do critério descricao: type: string description: Descrição do critério tipoDistribuicao: type: string allOf: – #/definitions/tipoDistribuicao description: Tipo de distribuição itensDistribuicao: type: array items: type: object allOf: – #/definitions/itensDistribuicao minimum: 1 description: Itens de distribuição dataAlteracao: type: string format: date-time description: Data de alteração recLancamentoSimulacao: description: Lançamento de simulação type: object required: – nivelAfetado – valor – observacao properties: id: type: integer format: int64 description: Identificador do lançamento nivelAfetado: type: integer format: int64 description: Nível afetado valor: type: string description: Valor do lançamento observacao: type: string description: Observação recTemplatePercentual: description: Template de percentual type: object required: – descricao – periodicidade – agrupamento – cadastroPercentuais properties: id: type: integer format: int64 description: Identificador do template descricao: type: string description: Descrição do template periodicidade: type: string allOf: – #/definitions/periodicidade description: Periodicidade agrupamento: type: string allOf: – #/definitions/agrupamento description: Agrupamento cadastroPercentuais: type: array items: type: object allOf: – #/definitions/cadastroPercentuais minimum: 1 description: Cadastro de percentuais filtroEmpresa: type: string description: Filtro de empresa usuarioGeracao: type: string description: Usuário que gerou usuarioAlteracao: type: string description: Usuário que alterou dataGeracao: type: string format: date-time description: Data de geração dataAlteracao: type: string format: date-time description: Data de alteração statusFluxo: description: Detalhes do status de um fluxo de caixa type: object properties: rotina: type: string description: Rotina do fluxo processo: type: string description: Processo do fluxo descricao: type: string description: Descrição do fluxo (padrão: vazia) dataGeracao: type: string format: date-time description: Data de geração do fluxo status: type: string allOf: – #/definitions/statusFluxoCaixa description: Status do fluxo 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 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

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação