2.0info: 16.4.7 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: 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: responses: 200: description: Ok schema: type: object required: – descricaoFluxo – usuarioGeracao – dataGeracao – parametrizacao properties: descricaoFluxo: type: string description: usuarioGeracao: type: string description: usuarioAlteracao: type: string description: dataGeracao: type: string format: date-time description: dataAlteracao: type: string format: date-time description: descricaoVisao: type: string description: dataAtualizacaoIntegracao: type: string format: date-time description: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: logsGeracao: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: 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: usuarioGeracao: type: string description: usuarioAlteracao: type: string description: dataGeracao: type: string format: date-time description: dataAlteracao: type: string format: date-time description: descricaoVisao: type: string description: dataAtualizacaoIntegracao: type: string format: date-time description: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: logsGeracao: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/incluirBaseHistorica: post: description: 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: responses: 200: description: Ok schema: type: object required: – incluirBaseHistorica properties: incluirBaseHistorica: type: array items: type: boolean minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/incluirTipoDivisao: post: description: 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: responses: 200: description: Ok schema: type: object required: – incluirTipoDivisao properties: incluirTipoDivisao: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterPercentualRotinas: post: description: 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: responses: 200: description: Ok schema: type: object required: – percentuais properties: percentuais: type: array items: type: object allOf: – #/definitions/caracteristicaRotina minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterLancamentosAgrupamento: post: description: 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: nivelAfetado: type: string description: responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: in: query required: true type: integer format: int64 – name: nivelAfetado description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterStatusFluxoCaixa: post: description: 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: responses: 200: description: Ok schema: type: object required: – status properties: processo: type: string description: status: type: string allOf: – #/definitions/statusFluxoCaixa description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoId description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – status properties: processo: type: string description: status: type: string allOf: – #/definitions/statusFluxoCaixa description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterParametrizacoesResumida: post: description: 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: responses: 200: description: Ok schema: type: object required: – totalRegistros – parametrizacao properties: totalRegistros: type: integer format: int64 description: parametrizacao: type: array items: type: object allOf: – #/definitions/parametrizacaoResumida minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterMovimentoDiversoResumido: post: description: 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: movimentoDiverso: type: array items: type: object allOf: – #/definitions/movimentoDiversoResumido minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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: movimentoDiverso: type: array items: type: object allOf: – #/definitions/movimentoDiversoResumido minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterCriterioDistribuicaoResumido: post: description: 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: criterioDistribuicao: type: array items: type: object allOf: – #/definitions/criterioDistribuicaoResumido minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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: criterioDistribuicao: type: array items: type: object allOf: – #/definitions/criterioDistribuicaoResumido minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterFluxoCaixaGeradoResumido: post: description: 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: responses: 200: description: Ok schema: type: object required: – totalRegistros – fluxoResumido properties: totalRegistros: type: integer format: int64 description: fluxoResumido: type: array items: type: object allOf: – #/definitions/fluxoResumido minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterPeriodoFluxo: post: description: 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: 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: linhasFluxo: type: array items: type: object allOf: – #/definitions/linhaFluxo minimum: 1 description: caixaMinimo: type: string description: limiteCredito: type: string description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idFluxo description: 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: linhasFluxo: type: array items: type: object allOf: – #/definitions/linhaFluxo minimum: 1 description: caixaMinimo: type: string description: limiteCredito: type: string description: totalRegistros: type: integer format: int64 description: 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.\n Para 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. 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a comparação entre um fluxo base e outros fluxos de caixas zerados.\n Para comparar, os fluxos envolvidos devem ter a mesma periodicidade e mesmo agrupador.\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fluxoIdBase description: Identificador do fluxo base in: query required: true type: integer format: int64 – name: fluxoComparacao description: Identificador dos fluxos a serem comaparados. Devem ser informado ao menos um fluxo in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: offset description: Número do período a partir do qual devem ser retornados dados de comparação in: query type: integer format: int64 – name: quantidade description: Quantidade de períodos que devem ser retornados pelo serviço. Cada período traz todos cenários envolvidos. in: query type: integer format: int64 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: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheTituloReceber minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalhePedido minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheContratoVenda minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheOrdemCompra minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheContratoCompra minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheTituloPagar minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheMovimentoDiverso minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheComissao minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheServicoPontoVenda minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheAplicacaoFinanceira minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheEmprestimos minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheTesouraria minimum: 1 description: totalRegistros: type: integer format: int64 description: 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: nivel: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – detalhes – totalRegistros properties: detalhes: type: array items: type: object allOf: – #/definitions/detalheExtratoBancario minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n agrupamentofilial.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – agrupamentosFilial – totalRegistros properties: agrupamentosFilial: type: array items: type: object allOf: – #/definitions/agrupamentoFilial minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n agrupamentofilial.empresa_id, agrupamentofilial.agrupamento\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – agrupamentosFilial – totalRegistros properties: agrupamentosFilial: type: array items: type: object allOf: – #/definitions/agrupamentoFilial minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n filial.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n filial.empresa_id, filial.filial\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n filial.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n filial.empresa_id, filial.filial\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: agrupamentoId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – filial – totalRegistros properties: filial: type: array items: type: object allOf: – #/definitions/filial minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n empresa.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: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaEmpresas – totalRegistros properties: listaEmpresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n empresa.id\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: in: query type: integer format: int64 – name: quantidade description: 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: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n tipotitulo.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaTipoTitulos – totalRegistros properties: listaTipoTitulos: type: array items: type: object allOf: – #/definitions/tipoTitulo minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTransacaoContasReceber: post: description: 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: 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: 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 get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: lista de empresas a serem filtradas para busca das transações in: query type: array items: type: integer format: int64 – 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: – 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: 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: 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: 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 get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: lista de empresas a serem filtradas para busca das transações in: query type: array items: type: integer format: int64 – 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: – 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: 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: 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 get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: lista de empresas a serem filtradas para busca das transações in: query type: array items: type: integer format: int64 – 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: – 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\n Deverá retornar ordenados por:\n grupoconta.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaGrupoContas – totalRegistros properties: listaGrupoContas: type: array items: type: object allOf: – #/definitions/grupoContas minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n condicaopagamento.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: aplicacao: type: array items: type: string allOf: – #/definitions/aplicacaoMercadoSuprimentos minimum: 1 description: responses: 200: description: Ok schema: type: object required: – listaCondicaoPagamento – totalRegistros properties: listaCondicaoPagamento: type: array items: type: object allOf: – #/definitions/condicaoPagamento minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n formapagamento.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaFormaPagamento – totalRegistros properties: listaFormaPagamento: type: array items: type: object allOf: – #/definitions/formaPagamento minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n formapagamento.empresa_id, formapagamento.forma_pagamento\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaFormaPagamento – totalRegistros properties: listaFormaPagamento: type: array items: type: object allOf: – #/definitions/formaPagamento minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n portador.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaPortador – totalRegistros properties: listaPortador: type: array items: type: object allOf: – #/definitions/portador minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n portador.empresa_id, portador.portador\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaPortador – totalRegistros properties: listaPortador: type: array items: type: object allOf: – #/definitions/portador minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n carteira.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: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaCarteira – totalRegistros properties: listaCarteira: type: array items: type: object allOf: – #/definitions/carteira minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n carteira.id\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: in: query type: integer format: int64 – name: quantidade description: 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: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n naturezagasto.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: tipoNaturezaGastos: type: array items: type: string allOf: – #/definitions/tipoNaturezaGastos description: responses: 200: description: Ok schema: type: object required: – listaNaturezaGastos – totalRegistros properties: listaNaturezaGastos: type: array items: type: object allOf: – #/definitions/naturezaGastos minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n moeda.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: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaMoeda – totalRegistros properties: listaMoeda: type: array items: type: object allOf: – #/definitions/moeda minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n moeda.id\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: in: query type: integer format: int64 – name: quantidade description: 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: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n moeda.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaMoeda – totalRegistros properties: listaMoeda: type: array items: type: object allOf: – #/definitions/moeda minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n moeda.id\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: 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: totalRegistros: type: integer format: int64 description: 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: dataBase: type: string format: date description: responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: 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: in: query required: true type: string – name: dataBase description: in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTipoConta: post: description: 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: 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 get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tipoConta description: define quais contas internas devem ser retornadas in: query type: array items: type: string – name: aplicacao description: in: query type: array items: type: integer format: int64 – 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: – 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\n Deverá retornar ordenados por:\n containterna.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: tipoContaId: type: array items: type: string description: aplicacaoContaInterna: type: array items: type: integer format: int64 description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaContaInterna – totalRegistros properties: listaContaInterna: type: array items: type: object allOf: – #/definitions/contaInterna minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n containterna.empresa_id, containterna.conta_interna\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: tipoContaId description: in: query type: array items: type: string – name: aplicacaoContaInterna description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaContaInterna – totalRegistros properties: listaContaInterna: type: array items: type: object allOf: – #/definitions/contaInterna minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n motivo.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaMotivo – totalRegistros properties: listaMotivo: type: array items: type: object allOf: – #/definitions/motivo minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n motivo.id\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: aplicacaoMotivo description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaMotivo – totalRegistros properties: listaMotivo: type: array items: type: object allOf: – #/definitions/motivo minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n tipodocumento.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaTipoDocumento – totalRegistros properties: listaTipoDocumento: type: array items: type: object allOf: – #/definitions/tipoDocumento minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n tipodocumento.empresa_id, tipodocumento.documento\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaTipoDocumento – totalRegistros properties: listaTipoDocumento: type: array items: type: object allOf: – #/definitions/tipoDocumento minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n projeto.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: naturezaProjeto: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: responses: 200: description: Ok schema: type: object required: – listaProjetos – totalRegistros properties: listaProjetos: type: array items: type: object allOf: – #/definitions/projeto minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n faseprojeto.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: projetoId: type: array items: type: integer format: int64 description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: naturezaFase: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: responses: 200: description: Ok schema: type: object required: – listaFaseProjetos – totalRegistros properties: listaFaseProjetos: type: array items: type: object allOf: – #/definitions/faseProjeto minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n contafinanceira.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: naturezaContaFinanceira: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: tipoTotaisContas: type: string allOf: – #/definitions/tipoTotaisContas description: responses: 200: description: Ok schema: type: object required: – listaContaFinanceira – totalRegistros properties: listaContaFinanceira: type: array items: type: object allOf: – #/definitions/contaFinanceira minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n contacontabil.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: naturezaContaContabil: type: array items: type: string allOf: – #/definitions/naturezaMovimento description: tipoTotaisContas: type: string allOf: – #/definitions/tipoTotaisContas description: responses: 200: description: Ok schema: type: object required: – listaContaContabil – totalRegistros properties: listaContaContabil: type: array items: type: object allOf: – #/definitions/contaContabil minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n centrocusto.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: tipoTotaisContas: type: string allOf: – #/definitions/tipoTotaisContas description: responses: 200: description: Ok schema: type: object required: – listaCentroCusto – totalRegistros properties: listaCentroCusto: type: array items: type: object allOf: – #/definitions/centroCusto minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n assessoriacobranca.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaAssessoriaCobranca – totalRegistros properties: listaAssessoriaCobranca: type: array items: type: object allOf: – #/definitions/assessoriaCobranca minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n assessoriacobranca.empresa_id, assessoriacobranca.assessoria\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaAssessoriaCobranca – totalRegistros properties: listaAssessoriaCobranca: type: array items: type: object allOf: – #/definitions/assessoriaCobranca minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n fasecobranca.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: assessoriaId: type: array items: type: integer format: int64 description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaFaseCobranca – totalRegistros properties: listaFaseCobranca: type: array items: type: object allOf: – #/definitions/faseCobranca minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n fasecobranca.empresa_id, fasecobranca.assessoria_id, fasecobranca.fase\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: assessoriaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaFaseCobranca – totalRegistros properties: listaFaseCobranca: type: array items: type: object allOf: – #/definitions/faseCobranca minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n produtobancario.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: tipoOperacao: type: integer format: int64 description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaProdutoBancario properties: listaProdutoBancario: type: array items: type: object allOf: – #/definitions/produtoBancario minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n produtobancario.empresa_id, produtobancario.numero\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: tipoOperacao description: in: query type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaProdutoBancario properties: listaProdutoBancario: type: array items: type: object allOf: – #/definitions/produtoBancario minimum: 1 description: 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\n Deverá retornar ordenados por:\n calculocontratofin.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaCalculoContratoFinanceiro – totalRegistros properties: listaCalculoContratoFinanceiro: type: array items: type: object allOf: – #/definitions/calculoContratoFinanceiro minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n calculocontratofin.empresa_id, calculocontratofin.numero\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaCalculoContratoFinanceiro – totalRegistros properties: listaCalculoContratoFinanceiro: type: array items: type: object allOf: – #/definitions/calculoContratoFinanceiro minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n banco.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaCorrespondenteBancario – totalRegistros properties: listaCorrespondenteBancario: type: array items: type: object allOf: – #/definitions/banco minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n banco.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: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaCorrespondenteBancario – totalRegistros properties: listaCorrespondenteBancario: type: array items: type: object allOf: – #/definitions/banco minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n produtocorrespondenteban.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: correspondenteId: type: array items: type: string description: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaProdutoCorrespondenteBancario – totalRegistros properties: listaProdutoCorrespondenteBancario: type: array items: type: object allOf: – #/definitions/produtoCorrespondenteBancario minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n produtocorrespondenteban.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: empresaId description: in: query type: array items: type: integer format: int64 – name: correspondenteId description: in: query type: array items: type: string – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaProdutoCorrespondenteBancario – totalRegistros properties: listaProdutoCorrespondenteBancario: type: array items: type: object allOf: – #/definitions/produtoCorrespondenteBancario minimum: 1 description: totalRegistros: type: integer format: int64 description: 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\n Deverá retornar ordenados por:\n operadortelefonia.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: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – listaOperadorTelefonia – totalRegistros properties: listaOperadorTelefonia: type: array items: type: object allOf: – #/definitions/operadorTelefonia minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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\n Deverá retornar ordenados por:\n operadortelefonia.empresa_id, operadortelefonia.operadora\n [out] totalRegistros: Quantidade total de registros da consulta\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query type: array items: type: integer format: int64 – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – listaOperadorTelefonia – totalRegistros properties: listaOperadorTelefonia: type: array items: type: object allOf: – #/definitions/operadorTelefonia minimum: 1 description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDiaUtil: post: description: 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: responses: 200: description: Ok schema: type: object required: – listaRetorno properties: listaRetorno: type: array items: type: object allOf: – #/definitions/diaUtil minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterDatasCalculadasTitulosReceber: post: description: 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: 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: 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: retorna o período inicial e final a partir do critério de busca periodoFinal: type: string format: date description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterSituacoesTitulo: post: description: 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: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterSaldoAnteriorContasInternas: post: description: 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: filialId: type: array items: type: integer format: int64 description: data: type: string format: date description: tipoData: type: string allOf: – #/definitions/tipoDataSaldo description: contaInternaId: type: array items: type: integer format: int64 description: tipoContaId: type: array items: type: string description: responses: 200: description: Ok schema: type: object required: – saldo properties: saldo: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterSaldoAnteriorExtratosBancarios: post: description: 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: data: type: string format: date description: contaInternaId: type: array items: type: integer format: int64 description: tipoContaId: type: array items: type: string description: filtroExtrato: type: string allOf: – #/definitions/filtroExtratos description: responses: 200: description: Ok schema: type: object required: – saldo properties: saldo: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/consistirEmpresasGeracaoFluxo: post: description: 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: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresasId description: in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/queries/obterTemplatePercentualResumido: post: description: 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: agrupamento: type: array items: type: string allOf: – #/definitions/agrupamento description: camposOrdenacao: type: array items: type: object allOf: – #/definitions/campoOrdenacao description: responses: 200: description: Ok schema: type: object required: – totalRegistros – templateResumido properties: totalRegistros: type: integer format: int64 description: templateResumido: type: array items: type: object allOf: – #/definitions/templatePercentualResumido minimum: 1 description: 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: 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: diferencaRealizacao: type: number format: double description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: 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: diferencaRealizacao: type: number format: double description: 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/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.\n Parâ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: responses: 200: description: Ok schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/solicitarGeracaoParcelas: post: description: 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: tamanhoLote: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – quantidadeSolicitada properties: quantidadeSolicitada: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/gerarFluxoCaixaVisao: post: description: 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: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – fluxoId properties: fluxoId: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/salvarFluxoCaixa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – descricao – fluxoId properties: descricao: type: string description: fluxoId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/removerFluxoCaixa: post: description: 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: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/removerAgrupamento: post: description: 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: nivelGrupo: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/aplicarCaracteristicaRotina: post: description: 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: rotina: type: array items: type: object allOf: – #/definitions/caracteristicaRotina minimum: 1 description: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/excluirDetalheAgrupamento: post: description: 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: nivelAfetado: type: string description: detalheId: type: integer format: int64 description: rateioId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/alterarDetalheAgrupamento: post: description: 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: nivelAfetado: type: string description: detalheId: type: integer format: int64 description: rateioId: type: integer format: int64 description: data: type: string format: date description: valor: type: string description: responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/alterarValorAgrupamento: post: description: 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: nivelAfetado: type: string description: novoValor: type: string description: responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/inserirLancamentoAgrupamento: post: description: 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: nivelAfetado: type: string description: valor: type: string description: observacao: type: string description: responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/excluirLancamentoAgrupamento: post: description: 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: nivelAfetado: type: string description: lancamentoId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/alterarLancamentoAgrupamento: post: description: 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: nivelAfetado: type: string description: lancamentoId: type: integer format: int64 description: valor: type: string description: observacao: type: string description: responses: 200: description: Ok schema: type: object required: – totalAgrupamento – lancamentos properties: totalAgrupamento: type: string description: lancamentos: type: array items: type: object allOf: – #/definitions/lancamentosAgrupamento minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/cancelarSimulacao: post: description: 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: cancelAll: type: boolean description: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/efetivarSimulacaoDetalhes: post: description: 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: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/gerarAplicacaoFinanceira: post: description: 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: dataAplicacao: type: string format: date description: valorInvestido: type: string description: percentual: type: number format: double description: prazoAplicacao: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/gerarEmprestimo: post: description: 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: dataContratacao: type: string format: date description: valorContratado: type: string description: percentual: type: number format: double description: quantidadePrestacoes: type: integer format: int64 description: diaDebito: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/actions/imprimirFluxoCaixa: post: description: 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: fluxoComparacao: type: array items: type: integer format: int64 description: 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: responses: 200: description: Ok schema: type: object required: – download properties: download: type: string format: byte description: 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/events/startup: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – dominio – servico properties: dominio: type: string description: servico: type: string description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/visao: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visao responses: 200: description: The created resource schema: #/definitions/visao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visao responses: 200: description: The created resource schema: #/definitions/visao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/visao/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visao responses: 200: description: Ok schema: #/definitions/visao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visao responses: 200: description: Ok schema: #/definitions/visao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/visao/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/movimentoDiverso: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/movimentoDiverso responses: 200: description: The created resource schema: #/definitions/movimentoDiverso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/movimentoDiverso responses: 200: description: The created resource schema: #/definitions/movimentoDiverso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/movimentoDiverso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/movimentoDiverso/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/movimentoDiverso responses: 200: description: Ok schema: #/definitions/movimentoDiverso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/movimentoDiverso responses: 200: description: Ok schema: #/definitions/movimentoDiverso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/movimentoDiverso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/movimentoDiverso/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/movimentoDiverso responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/criterioDistribuicaoVencidos: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/criterioDistribuicaoVencidos responses: 200: description: The created resource schema: #/definitions/criterioDistribuicaoVencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/criterioDistribuicaoVencidos responses: 200: description: The created resource schema: #/definitions/criterioDistribuicaoVencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/criterioDistribuicaoVencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/criterioDistribuicaoVencidos/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/criterioDistribuicaoVencidos responses: 200: description: Ok schema: #/definitions/criterioDistribuicaoVencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/criterioDistribuicaoVencidos responses: 200: description: Ok schema: #/definitions/criterioDistribuicaoVencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/criterioDistribuicaoVencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/criterioDistribuicaoVencidos/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/criterioDistribuicaoVencidos responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/lancamentoSimulacao: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lancamentoSimulacao responses: 200: description: The created resource schema: #/definitions/lancamentoSimulacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lancamentoSimulacao responses: 200: description: The created resource schema: #/definitions/lancamentoSimulacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lancamentoSimulacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/lancamentoSimulacao/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lancamentoSimulacao responses: 200: description: Ok schema: #/definitions/lancamentoSimulacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lancamentoSimulacao responses: 200: description: Ok schema: #/definitions/lancamentoSimulacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lancamentoSimulacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/lancamentoSimulacao/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lancamentoSimulacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/templatePercentual: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/templatePercentual responses: 200: description: The created resource schema: #/definitions/templatePercentual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/templatePercentual responses: 200: description: The created resource schema: #/definitions/templatePercentual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/templatePercentual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/templatePercentual/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/templatePercentual responses: 200: description: Ok schema: #/definitions/templatePercentual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/templatePercentual responses: 200: description: Ok schema: #/definitions/templatePercentual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/templatePercentual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_fluxocaixa/entities/templatePercentual/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/templatePercentual responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: tipoRotinaGeracaoParcelas: description: type: string enum: – Pedido – OrdemCompra – ContratoCompra – ContratoVenda statusFluxoCaixa: description: type: string enum: – Temporario – EmProcessamento – Processado rotinaImpressao: description: Rotinas de impressão 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 rotinaFluxo: description: 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 tipoOrigem: description: type: string enum: – Nenhum – Agrupador – Detalhe tipoVisao: description: type: string enum: – Previsto – PrevistoReal – Realizado – Projetado – Orcamentaria – PrevistoCongelado tipoVisaoMovimentoDiverso: description: type: string enum: – Previsto – PrevistoReal – Ambos periodicidade: description: type: string enum: – Diario – Semanal – Quinzenal – Mensal – Trimestral – Semestral – Anual agrupamento: description: type: string enum: – ContaFinanceira – ContaContabil – CentroCustos – FormaPagamento – NaturezaGasto – OrigemInformacao – Projeto – ProjetoFase – Moeda ordenacaoAgrupamento: description: type: string enum: – CodigoAbreviatura – Abreviatura – ClassificacaoAbreviatura – Descricao – CodigoDescricao aplicacaoFinanceiro: description: type: string enum: – Ambos – ContasPagar – ContasReceber modulosTransacao: description: type: string enum: – CRE – CRP – CRB – CPE – CPP – CPB – VEP – VEF – VES – COO – COF – COS – CBM – CPM origemRealizado: description: type: string enum: – Baixas – Tesouraria – ExtratosBancarios – EntradaTitulosEfetivos baseHistorica: description: type: string enum: – Nenhum – MovimentacoesHistoricas – Orcamento visualizacaoGrafico: description: type: string enum: – Valor – Percentual – PercentualValor impressaoGrafico: description: type: string enum: – LinhaColunaPizza – LinhaPizzaColuna – ColunaPizzaColuna – BarraPizzaBarra – LinhaColunaColuna – BarraBarraBarra – ColunaColunaColuna origemSaldo: description: type: string enum: – Valor – ContaInterna – ExtratoBancario tipoDataSaldo: description: type: string enum: – DataMovimento – DataLiberacao tipoBuscaMovimento: description: type: string enum: – DataMovimento – DataLiberacao – DataMovimentoPrevista tipoBuscaBaseHistorica: description: type: string enum: – RealizadoContasReceber – RealizadoContasPagar – RealizadoTesouraria – TitulosEfetivos – ExtratoBancario categoriaTitulos: description: type: string enum: – Previstos – Efetivos – Ambos tipoVencimentoTitulo: description: type: string enum: – ProvavelPagamento – VencimentoOriginal – VencimentoProrrogado origemTesouraria: description: type: string enum: – CM – CP – CR – CH – OU tipoDistribuicao: description: type: string enum: – Nenhum – Diario – Mensal tipoParcela: description: type: string enum: – Ambas – ComParcelaEspecial – SemParcelaEspecial tipoContrato: description: type: string enum: – ComercialNormal – ComercialAdicional – ComercialSocios – ComercialVariavel criterioFaturamento: description: type: string enum: – QuantidadeParcela – Validade – Ambos situacaoComercial: description: type: string enum: – AbertoTotal – AbertoParcial – Suspenso – PreparacaoAnaliseNotaFiscal origemOrcamento: description: type: string enum: – ContaFinanceira – ContaContabil – CentroCustos – Projeto – ProjetoFase – FormaPagamento origemOrcamentoCentroCustos: description: type: string enum: – Contabil – Financeiro – Projeto origemOrcamentoProjetos: description: type: string enum: – RegimeEntrada – RegimeSaida origemOrcamentoContaFinanceira: description: type: string enum: – Financeiro – Projeto periodoFluxo: description: type: string enum: – EstaSemana – EstaQuinzena – EsteMes – EsteBimestre – EsteTrimestre – EsteSemestre – EsteAno – PeriodoDeAte tipoRecebimento: description: type: string enum: – CorrespondenteBancario – RecargaCelular – Ambos tipoNaturezaGastos: description: type: string enum: – Normal – Recebimento – Transferencia tipoValor: description: type: string enum: – ValorAberto – ValorOriginal naturezaMovimento: description: type: string enum: – Credito – Debito tipoTotaisContas: description: type: string enum: – Analitico – Sintetico – Ambos aplicacaoMercadoSuprimentos: description: type: string enum: – Compras – Vendas – Ambos buscaVencimentoContasReceber: description: type: string enum: – FloatBancario – AtrasoMedio – PrazoMedio calculoFinanceiroTitulos: description: type: string enum: – Juros – Multa – Descontos – Reajuste – OutrosAcrescimos – CorrecaoMonetaria tipoOrdenacao: description: type: string enum: – Crescente – Decrescente impostos: description: type: string enum: – IRRF – INSS – ISS – COFINS – PIS – CSLL – OutrasRetencoes enumTipoExportacao: description: type: string enum: – XLS – XLSX rotinaAlterada: description: 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 formatoImpressao: description: type: string enum: – PDF_NORMAL – PDF_RESUMIDO – PDF_EXPANDIDO – TXT – XLS – XLSX filtroExtratos: description: type: string enum: – Conciliados – NaoConciliados – Todos enumVisualizacaoNiveis: description: type: string enum: – NiveisLancamento – NiveisSinteticos – TodosNiveis divisaoBaseHistorica: description: type: string enum: – PeriodoDestino – PeriodoOrigem upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT dadosComparacaoFluxo: description: type: object required: – idFluxo – saldo – contasReceber – contasPagar properties: idFluxo: type: integer format: int64 description: saldo: type: string description: contasReceber: type: string description: contasPagar: type: string description: estruturaLinha: description: discriminator: _discriminator type: object required: – nivel – valor – _discriminator properties: nivel: type: string description: valor: type: string description: fluxoCaixaId: type: integer format: int64 description: _discriminator: type: string description: estruturaLinhaComparacao: description: allOf: – #/definitions/estruturaLinha – type: object required: – diferenca – percentualDiferenca properties: diferenca: type: string description: percentualDiferenca: type: number format: double description: linhaFluxo: description: type: object required: – nivel – label – hierarquia – descricaoEmpresa – tipo – percentual – rotina – linha – filhos properties: nivel: type: string description: label: type: string description: hierarquia: type: string description: descricaoEmpresa: type: string description: tipo: type: string allOf: – #/definitions/tipoOrigem description: percentual: type: number format: double description: rotina: type: string description: linha: type: array items: type: object allOf: – #/definitions/estruturaLinha minimum: 1 description: filhos: type: array items: type: object allOf: – #/definitions/linhaFluxo minimum: 1 description: tituloReceberInicializacao: description: type: object required: – empresaId – filialId – numeroTitulo – tipoTipoId – clienteId – portadorId – original – provavel – prorrogado properties: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: numeroTitulo: type: string description: tipoTipoId: type: string description: clienteId: type: integer format: int64 description: portadorId: type: integer format: int64 description: original: type: string format: date description: provavel: type: string format: date description: prorrogado: type: string format: date description: idG7: type: integer format: int64 description: tituloPagarInicializacao: description: type: object required: – empresaId – filialId – numeroTitulo – tipoTipoId – fornecedorId – original – provavel – prorrogado properties: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: numeroTitulo: type: string description: tipoTipoId: type: string description: fornecedorId: type: integer format: int64 description: original: type: string format: date description: provavel: type: string format: date description: prorrogado: type: string format: date description: idG7: type: integer format: int64 description: historicoCliente: description: type: object required: – empresaId – filialId – clienteId properties: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: clienteId: type: integer format: int64 description: datasTitulos: description: 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: originalFloat: type: string format: date description: originalAtraso: type: string format: date description: originalPrazo: type: string format: date description: originalFloatAtraso: type: string format: date description: originalFloatPrazo: type: string format: date description: originalAtrasoPrazo: type: string format: date description: originalFloatAtrasoPrazo: type: string format: date description: provavelUtil: type: string format: date description: provavelFloat: type: string format: date description: provavelAtraso: type: string format: date description: provavelPrazo: type: string format: date description: provavelFloatAtraso: type: string format: date description: provavelFloatPrazo: type: string format: date description: provavelAtrasoPrazo: type: string format: date description: provavelFloatAtrasoPrazo: type: string format: date description: prorrogadoUtil: type: string format: date description: prorrogadoFloat: type: string format: date description: prorrogadoAtraso: type: string format: date description: prorrogadoPrazo: type: string format: date description: prorrogadoFloatAtraso: type: string format: date description: prorrogadoFloatPrazo: type: string format: date description: prorrogadoAtrasoPrazo: type: string format: date description: prorrogadoFloatAtrasoPrazo: type: string format: date description: datasCalculadasReceber: description: type: object required: – titulos – datas properties: titulos: type: object allOf: – #/definitions/tituloReceberInicializacao description: datas: type: object allOf: – #/definitions/datasTitulos description: datasCalculadasPagar: description: type: object required: – titulos – datas properties: titulos: type: object allOf: – #/definitions/tituloPagarInicializacao description: datas: type: object allOf: – #/definitions/datasTitulos description: parametrizacaoResumida: description: type: object required: – id – descricao – tipoVisao – periodicidade – agrupamento – usuarioGeracao – dataGeracao – favorita properties: id: type: integer format: int64 description: descricao: type: string description: tipoVisao: type: string description: periodicidade: type: string description: agrupamento: type: string description: dataBase: type: string format: date description: considerarDiaNaoUtil: type: boolean description: usuarioGeracao: type: string description: usuarioAlteracao: type: string description: dataGeracao: type: string description: dataAlteracao: type: string description: favorita: type: boolean description: movimentoDiversoResumido: description: type: object required: – id – empresa – filial – dataMovimento – tipoMovimento – tipoAgrupamento – valorMovimento – usuarioAlteracao – dataAlteracao – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: filial: type: object allOf: – #/definitions/filial description: dataMovimento: type: string description: tipoMovimento: type: string allOf: – #/definitions/naturezaMovimento description: tipoAgrupamento: type: array items: type: string allOf: – #/definitions/agrupamento minimum: 1 description: valorMovimento: type: string description: usuarioAlteracao: type: string description: dataAlteracao: type: string description: descricao: type: string description: criterioDistribuicaoResumido: description: type: object required: – id – descricao – tipoDistribuicao – usuarioAlteracao – dataAlteracao properties: id: type: integer format: int64 description: descricao: type: string description: tipoDistribuicao: type: string allOf: – #/definitions/tipoDistribuicao description: usuarioAlteracao: type: string description: dataAlteracao: type: string description: fluxoResumido: description: type: object required: – id – descricao – tipoVisao – periodicidade – agrupamento – usuarioGeracao – dataGeracao properties: id: type: integer format: int64 description: descricao: type: string description: tipoVisao: type: string allOf: – #/definitions/tipoVisao description: periodicidade: type: string allOf: – #/definitions/periodicidade description: agrupamento: type: string allOf: – #/definitions/agrupamento description: ordenacaoAgrupamento: type: string allOf: – #/definitions/ordenacaoAgrupamento description: dataBase: type: string format: date description: considerarDiaNaoUtil: type: boolean description: usuarioGeracao: type: string description: dataGeracao: type: string description: usuarioAlteracao: type: string description: dataAlteracao: type: string description: situacao: type: string description: limiteCredito: type: string description: periodo: description: type: object required: – label – itens properties: label: type: string description: itens: type: array items: type: string minimum: 1 description: dataPeriodo: description: type: object required: – label – valor properties: label: type: string description: valor: type: string description: saldo: description: type: object required: – label – valor properties: label: type: string description: valor: type: string description: campoOrdenacao: description: type: object required: – campo – ordem properties: campo: type: string description: ordem: type: string allOf: – #/definitions/tipoOrdenacao description: detalheGeral: description: discriminator: _discriminator type: object required: – id – idEmpresa – nomeFantasiaEmpresa – idFilial – nomeFilial – dataPadrao – dataUtilizada – valorLiquido – _discriminator properties: id: type: integer format: int64 description: idEmpresa: type: integer format: int64 description: nomeFantasiaEmpresa: type: string description: idFilial: type: integer format: int64 description: nomeFilial: type: string description: dataPadrao: type: string format: date description: dataUtilizada: type: string format: date description: valorLiquido: type: string description: idRateio: type: integer format: int64 description: valorRateio: type: string description: dataGeracao: type: string format: date-time description: usuarioGeracao: type: string description: _discriminator: type: string description: detalheTituloReceber: description: 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: nomeCliente: type: string description: numeroTitulo: type: string description: idTipoTitulo: type: string description: descricaoTipoTitulo: type: string description: idPortador: type: string description: descricaoPortador: type: string description: idCarteira: type: string description: descricaoCarteira: type: string description: idSituacaoTitulo: type: string description: descricaoSituacaoTitulo: type: string description: indicativoProprio: type: string description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idNaturezaGastos: type: integer format: int64 description: descricaoNaturezaGastos: type: string description: observacao: type: string description: status: type: integer format: int64 description: descricaoStatus: type: string description: idMoeda: type: string description: idTransacaoEntrada: type: string description: descricaoTransacaoEntrada: type: string description: idTransacaoBaixa: type: string description: descricaoTransacaoBaixa: type: string description: tipoVencimento: type: string description: composicaoValorLiquido: type: object allOf: – #/definitions/composicaoValorLiquidoTituloReceber description: detalhePedido: description: 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: nomeCliente: type: string description: numeroPedido: type: integer format: int64 description: parcela: type: integer format: int64 description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idCondicaoPagamento: type: string description: descricaoCondicaoPagamento: type: string description: idTransacao: type: string description: descricaoTransacao: type: string description: idMoeda: type: string description: cotacaoItem: type: number format: double description: parcelaEspecial: type: string description: produto: type: string description: detalheContratoVenda: description: 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: nomeCliente: type: string description: numeroContrato: type: integer format: int64 description: tipoContrato: type: integer format: int64 description: descricaoTipoContrato: type: string description: parcela: type: integer format: int64 description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idMotivo: type: integer format: int64 description: descricaoMotivo: type: string description: criterioFaturamento: type: string description: idTransacao: type: string description: descricaoTransacao: type: string description: idCondicaoPagamento: type: string description: descricaoCondicaoPagamento: type: string description: idMoeda: type: string description: cotacaoItem: type: number format: double description: produto: type: string description: detalheOrdemCompra: description: 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: nomeFornecedor: type: string description: parcela: type: integer format: int64 description: numeroOrdemCompra: type: integer format: int64 description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idTransacao: type: string description: descricaoTransacao: type: string description: idCondicaoPagamento: type: string description: descricaoCondicaoPagamento: type: string description: idMoeda: type: string description: cotacaoItem: type: number format: double description: parcelaEspecial: type: string description: produto: type: string description: detalheContratoCompra: description: 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: nomeFornecedor: type: string description: numeroContrato: type: integer format: int64 description: tipoContrato: type: integer format: int64 description: descricaoTipoContrato: type: string description: parcela: type: integer format: int64 description: idCondicaoPagamento: type: string description: descricaoCondicaoPagamento: type: string description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idMotivo: type: integer format: int64 description: descricaoMotivo: type: string description: idTransacao: type: string description: descricaoTransacao: type: string description: idMoeda: type: string description: cotacaoItem: type: number format: double description: produto: type: string description: detalheTituloPagar: description: 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: nomeFornecedor: type: string description: numeroTitulo: type: string description: idTipoTitulo: type: string description: descricaoTipoTitulo: type: string description: idPortador: type: string description: descricaoPortador: type: string description: idCarteira: type: string description: descricaoCarteira: type: string description: idSituacaoTitulo: type: string description: descricaoSituacaoTitulo: type: string description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idNaturezaGastos: type: integer format: int64 description: descricaoNaturezaGastos: type: string description: observacao: type: string description: status: type: integer format: int64 description: descricaoStatus: type: string description: idMoeda: type: string description: idTransacaoEntrada: type: string description: descricaoTransacaoEntrada: type: string description: idTransacaoBaixa: type: string description: descricaoTransacaoBaixa: type: string description: idGrupo: type: string description: descricaoGrupo: type: string description: tipoVencimento: type: string description: composicaoValorLiquido: type: object allOf: – #/definitions/composicaoValorLiquidoTituloPagar description: detalheTesouraria: description: 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: descricaoContaInterna: type: string description: historicoMovimento: type: string description: sequenciaMovimento: type: integer format: int64 description: sequenciaPreparacao: type: string description: origemMovimento: type: string description: descricaoOrigem: type: string description: numeroDocumento: type: string description: numeroCheque: type: integer format: int64 description: idNaturezaGastos: type: integer format: int64 description: descricaoNaturezaGastos: type: string description: idTransacao: type: string description: descricaoTransacao: type: string description: idTipoContaInterna: type: string description: descricaoTipoContaInterna: type: string description: movimentoBloqueado: type: string description: observacao: type: string description: detalheExtratoBancario: description: allOf: – #/definitions/detalheGeral – type: object required: – idContaInterna – descricaoContaInterna – historicoExtrato – sequenciaExtrato – numeroDocumento – numeroCheque – idTipoContaInterna – descricaoTipoContaInterna – conciliado properties: idContaInterna: type: string description: descricaoContaInterna: type: string description: historicoExtrato: type: string description: sequenciaExtrato: type: integer format: int64 description: numeroDocumento: type: string description: numeroCheque: type: integer format: int64 description: idTipoContaInterna: type: string description: descricaoTipoContaInterna: type: string description: conciliado: type: string description: detalheEmprestimos: description: 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: descricaoContratoAplicacao: type: string description: idProdutoBancario: type: integer format: int64 description: descricaoProdutoBancario: type: string description: idCalculoContrato: type: integer format: int64 description: descricaoCalculoContrato: type: string description: idFornecedor: type: integer format: int64 description: nomeFornecedor: type: string description: numeroTitulo: type: string description: idTipoTitulo: type: string description: descricaoTipoTitulo: type: string description: idPortador: type: string description: descricaoPortador: type: string description: idCarteira: type: string description: descricaoCarteira: type: string description: idSituacaoTitulo: type: string description: descricaoSituacaoTitulo: type: string description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idNaturezaGastos: type: integer format: int64 description: descricaoNaturezaGastos: type: string description: observacao: type: string description: status: type: integer format: int64 description: idMoeda: type: string description: idTransacaoEntrada: type: string description: descricaoTransacaoEntrada: type: string description: idTransacaoBaixa: type: string description: descricaoTransacaoBaixa: type: string description: idGrupo: type: string description: descricaoGrupo: type: string description: tipoVencimento: type: string description: composicaoValorLiquido: type: object allOf: – #/definitions/composicaoValorLiquidoTituloPagar description: detalheAplicacaoFinanceira: description: 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: descricaoContaInterna: type: string description: sequenciaMovimento: type: integer format: int64 description: historicoMovimento: type: string description: idNaturezaGastos: type: integer format: int64 description: descricaoNaturezaGastos: type: string description: idTransacao: type: string description: descricaoTransacao: type: string description: contratoAplicacao: type: integer format: int64 description: descricaoContratoAplicacao: type: string description: idProdutoBancario: type: integer format: int64 description: descricaoProdutoBancario: type: string description: idCalculoContrato: type: integer format: int64 description: descricaoCalculoContrato: type: string description: detalheServicoPontoVenda: description: allOf: – #/definitions/detalheGeral – type: object required: – idCorrespondente – descricaoCorrespondente – idOperadora – descricaoOperadora properties: idCorrespondente: type: integer format: int64 description: descricaoCorrespondente: type: string description: idOperadora: type: integer format: int64 description: descricaoOperadora: type: string description: detalheComissao: description: allOf: – #/definitions/detalheGeral – type: object required: – idRepresentante – descricaoRepresentante – sequenciaComissao – observacao – idAssessoriaCobranca – descricaoAssessoriaCobranca – idFaseCobranca – descricaoFaseCobranca – naturezaComissao – idTransacao – descricaoTransacao properties: idRepresentante: type: integer format: int64 description: descricaoRepresentante: type: string description: sequenciaComissao: type: integer format: int64 description: observacao: type: string description: idAssessoriaCobranca: type: integer format: int64 description: descricaoAssessoriaCobranca: type: string description: idFaseCobranca: type: integer format: int64 description: descricaoFaseCobranca: type: string description: naturezaComissao: type: string description: idTransacao: type: string description: descricaoTransacao: type: string description: detalheMovimentoDiverso: description: allOf: – #/definitions/detalheGeral – type: object required: – numeroMovimento – observacao – idFormaPagamento – descricaoFormaPagamento – idNaturezaGastos – descricaoNaturezaGastos properties: numeroMovimento: type: integer format: int64 description: observacao: type: string description: idFormaPagamento: type: integer format: int64 description: descricaoFormaPagamento: type: string description: idNaturezaGastos: type: integer format: int64 description: descricaoNaturezaGastos: type: string description: 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: type: object required: – valorAberto – valorJuros – valorMulta – valorCorrecao – valorDescontos – valorEncargos – valorOutrosAcrescimos – valorOutrosDescontos – valorImpostoRenda – valorCOFINS – valorPIS – valorCSLL – valorOutrasRetencoes – valorLiquido – valorOriginal – valorMovimentoBaixa properties: valorAberto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorCorrecao: type: string description: valorDescontos: type: string description: valorEncargos: type: string description: valorOutrosAcrescimos: type: string description: valorOutrosDescontos: type: string description: valorImpostoRenda: type: string description: valorCOFINS: type: string description: valorPIS: type: string description: valorCSLL: type: string description: valorOutrasRetencoes: type: string description: valorLiquido: type: string description: valorOriginal: type: string description: valorMovimentoBaixa: type: string description: composicaoValorLiquidoTituloPagar: description: type: object required: – valorAberto – valorJuros – valorMulta – valorCorrecao – valorDescontos – valorEncargos – valorOutrosAcrescimos – valorOutrosDescontos – valorImpostoRenda – valorCOFINS – valorPIS – valorCSLL – valorOutrasRetencoes – valorLiquido – valorOriginal – valorMovimentoBaixa properties: valorAberto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorCorrecao: type: string description: valorDescontos: type: string description: valorEncargos: type: string description: valorOutrosAcrescimos: type: string description: valorOutrosDescontos: type: string description: valorImpostoRenda: type: string description: valorCOFINS: type: string description: valorPIS: type: string description: valorCSLL: type: string description: valorOutrasRetencoes: type: string description: valorLiquido: type: string description: valorOriginal: type: string description: valorMovimentoBaixa: type: string description: grupoTitulos: description: type: object required: – nome – total properties: nome: type: string description: total: type: string description: cliente: description: type: object required: – id – nome properties: id: type: integer format: int64 description: nome: type: string description: tituloReceber: description: 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: empresa: type: object allOf: – #/definitions/empresa description: filial: type: object allOf: – #/definitions/filial description: tipoTitulo: type: object allOf: – #/definitions/tipoTitulo description: cliente: type: object allOf: – #/definitions/cliente description: transacaoEntrada: type: object allOf: – #/definitions/transacao description: numero_titulo: type: string description: moeda: type: object allOf: – #/definitions/moeda description: valor_original: type: string description: valor_aberto: type: string description: dataOriginal: type: string description: dataUtil: type: string description: dataFloatAtrasoPrazo: type: string description: observacao: type: string description: portador: type: object allOf: – #/definitions/portador description: carteira: type: object allOf: – #/definitions/carteira description: formaPagamento: type: object allOf: – #/definitions/formaPagamento description: grupoConta: type: object allOf: – #/definitions/grupoContas description: situacao: type: object allOf: – #/definitions/situacaoTitulo description: naturezaGasto: type: object allOf: – #/definitions/naturezaGastos description: empresa: description: type: object required: – id – nomeFantasia – siglaMoeda properties: id: type: integer format: int64 description: nomeFantasia: type: string description: siglaMoeda: type: string description: agrupamentoFilial: description: type: object required: – id – empresa – codigo – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: codigo: type: integer format: int64 description: descricao: type: string description: filial: description: type: object required: – id – empresaId – codigoFilial – agrupamento – nome – fantasia – cidade – estado properties: id: type: integer format: int64 description: empresaId: type: object allOf: – #/definitions/empresa description: codigoFilial: type: integer format: int64 description: agrupamento: type: object allOf: – #/definitions/agrupamentoFilial description: nome: type: string description: fantasia: type: string description: cidade: type: string description: estado: type: string description: tipoTitulo: description: type: object required: – id – descricao – descricaoTipoSomaReceber – descricaoTipoSomaPagar – aplicacaoTipo – descricaoAplicacaoTipo – descricaoSituacao properties: id: type: string description: descricao: type: string description: descricaoTipoSomaReceber: type: string description: descricaoTipoSomaPagar: type: string description: aplicacaoTipo: type: string allOf: – #/definitions/aplicacaoFinanceiro description: descricaoAplicacaoTipo: type: string description: descricaoSituacao: type: string description: transacao: description: type: object required: – id – empresa – transacao – nome – modulo – descricaoModulo properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: transacao: type: string description: nome: type: string description: modulo: type: string description: descricaoModulo: type: string description: grupoContas: description: type: object required: – id – descricao – aplicacaoGrupo – descricaoAplicacaoGrupo – descricaoSituacao properties: id: type: string description: descricao: type: string description: aplicacaoGrupo: type: string allOf: – #/definitions/aplicacaoFinanceiro description: descricaoAplicacaoGrupo: type: string description: descricaoSituacao: type: string description: condicaoPagamento: description: type: object required: – id – empresa – condicao – descricaoCondicao – aplicacao – descricaoAplicacao – situacao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: condicao: type: string description: descricaoCondicao: type: string description: aplicacao: type: string description: descricaoAplicacao: type: string description: situacao: type: string description: formaPagamento: description: type: object required: – id – empresa – formaPagamento – descricao – tipo – descricaoSituacao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: formaPagamento: type: integer format: int64 description: descricao: type: string description: tipo: type: string description: descricaoSituacao: type: string description: moeda: description: type: object required: – id – nome – sigla properties: id: type: string description: nome: type: string description: sigla: type: string description: idG7: type: integer format: int64 description: banco: description: type: object required: – id – nome – correspondente properties: id: type: string description: nome: type: string description: correspondente: type: string description: agencia: description: type: object required: – id – banco – agencia – nome properties: id: type: integer format: int64 description: banco: type: object allOf: – #/definitions/banco description: agencia: type: string description: nome: type: string description: tipoConta: description: type: object required: – id – descricao – aplicacao properties: id: type: string description: descricao: type: string description: aplicacao: type: integer format: int64 description: contaInterna: description: type: object required: – id – empresa – contaInterna – descricao – banco – agencia – tipoConta – moeda – numeroContaBancaria – floatBancario properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: contaInterna: type: string description: descricao: type: string description: banco: type: object allOf: – #/definitions/banco description: agencia: type: object allOf: – #/definitions/agencia description: tipoConta: type: object allOf: – #/definitions/tipoConta description: moeda: type: object allOf: – #/definitions/moeda description: numeroContaBancaria: type: string description: floatBancario: type: integer format: int64 description: situacao: type: string description: portador: description: type: object required: – id – empresa – portador – descricao – floatBancario – descricaoContaInterna properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: portador: type: string description: descricao: type: string description: floatBancario: type: integer format: int64 description: descricaoContaInterna: type: string description: carteira: description: type: object required: – id – descricao – indicativo properties: id: type: string description: descricao: type: string description: indicativo: type: string description: naturezaGastos: description: type: object required: – id – empresa – naturezaGasto – descricao – tipoNatureza properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: naturezaGasto: type: integer format: int64 description: descricao: type: string description: tipoNatureza: type: string description: motivo: description: type: object required: – id – descricao – aplicacao – descricaoAplicacao properties: id: type: integer format: int64 description: descricao: type: string description: aplicacao: type: integer format: int64 description: descricaoAplicacao: type: string description: limiteCredito: description: type: object required: – utilizaLimite properties: utilizaLimite: type: boolean description: moedaVisao: description: type: object required: – moedaId – cotacao – percentual properties: moedaId: type: string description: cotacao: type: number format: double description: percentual: type: number format: double description: grafico: description: type: object required: – geraGrafico – niveis properties: geraGrafico: type: boolean description: niveis: type: string allOf: – #/definitions/impressaoGrafico description: saldoContaInterna: description: type: object required: – tipoData properties: tipoData: type: string allOf: – #/definitions/tipoDataSaldo description: contaInternaId: type: array items: type: integer format: int64 description: tipoContaId: type: array items: type: string description: saldoValorDigitado: description: type: object properties: valor: type: string description: saldoInicial: description: type: object required: – tipoSaldo properties: tipoSaldo: type: string allOf: – #/definitions/origemSaldo description: saldoContaInterna: type: object allOf: – #/definitions/saldoContaInterna description: saldoValorDigitado: type: object allOf: – #/definitions/saldoValorDigitado description: saldoExtratoBancario: type: object allOf: – #/definitions/saldoExtratoBancario description: saldoExtratoBancario: description: type: object required: – filtroExtrato properties: filtroExtrato: type: string allOf: – #/definitions/filtroExtratos description: contaInternaId: type: array items: type: integer format: int64 description: tipoContaId: type: array items: type: string description: situacaoTitulo: description: type: object required: – id – descricao properties: id: type: string description: descricao: type: string description: simulacaoImpostos: description: type: object required: – considera properties: considera: type: boolean description: percentual: type: number format: double description: impostos: type: array items: type: string allOf: – #/definitions/impostos description: composicaoDistribuicao: description: type: object required: – periodoInicial – periodoFinal – percentual properties: periodoInicial: type: integer format: int64 description: periodoFinal: type: integer format: int64 description: percentual: type: number format: double description: distribuicaoVencidos: description: type: object required: – id – tipoDistribuicao properties: id: type: integer format: int64 description: tipoDistribuicao: type: string allOf: – #/definitions/tipoDistribuicao description: distribuicao: type: array items: type: object allOf: – #/definitions/composicaoDistribuicao description: parametrosBase: description: discriminator: _discriminator type: object required: – considera – _discriminator properties: considera: type: boolean description: percentualEfetivos: type: number format: double description: percentualPrevistos: type: number format: double description: _discriminator: type: string description: parametrosContasReceber: description: allOf: – #/definitions/parametrosBase – type: object properties: categoria: type: string allOf: – #/definitions/categoriaTitulos description: buscaVencimentoContasReceber: type: array items: type: string allOf: – #/definitions/buscaVencimentoContasReceber description: calculoFinanceiroTitulos: type: array items: type: string allOf: – #/definitions/calculoFinanceiroTitulos description: tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: situacaoTitulo: type: array items: type: string description: tipoTitulo: type: array items: type: string description: transacaoEntrada: type: array items: type: integer format: int64 description: transacaoBaixa: type: array items: type: integer format: int64 description: grupo: type: array items: type: string description: formaPagamento: type: array items: type: integer format: int64 description: portador: type: array items: type: integer format: int64 description: carteira: type: array items: type: string description: naturezaGastos: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: tipoConta: type: array items: type: string description: contaInterna: type: array items: type: integer format: int64 description: simulacaoImpostos: type: object allOf: – #/definitions/simulacaoImpostos description: tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: considerarDerivativos: type: boolean description: produtoBancario: type: array items: type: integer format: int64 description: distribuirVencidos: description: type: object required: – considera properties: considera: type: boolean description: cadastroDistribuicaoVencidosId: type: integer format: int64 description: categoria: type: string allOf: – #/definitions/categoriaTitulos description: percentualLimite: type: number format: double description: utilizaMesmoFiltro: type: boolean description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: calculoFinanceiroTitulos: type: array items: type: string allOf: – #/definitions/calculoFinanceiroTitulos description: tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: situacaoTitulo: type: array items: type: string description: tipoTitulo: type: array items: type: string description: transacaoEntrada: type: array items: type: integer format: int64 description: grupo: type: array items: type: string description: formaPagamento: type: array items: type: integer format: int64 description: portador: type: array items: type: integer format: int64 description: carteira: type: array items: type: string description: naturezaGastos: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: consideraNaoAprovados: type: boolean description: parametrosPedido: description: allOf: – #/definitions/parametrosBase – type: object properties: tipoParcela: type: string allOf: – #/definitions/tipoParcela description: transacaoProduto: type: array items: type: integer format: int64 description: transacaoServico: type: array items: type: integer format: int64 description: condicaoPagamento: type: array items: type: integer format: int64 description: formaPagamento: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: situacao: type: array items: type: string allOf: – #/definitions/situacaoComercial description: parametrosContratoVenda: description: allOf: – #/definitions/parametrosBase – type: object properties: transacaoProduto: type: array items: type: integer format: int64 description: transacaoServico: type: array items: type: integer format: int64 description: tipoContrato: type: array items: type: string allOf: – #/definitions/tipoContrato description: condicaoPagamento: type: array items: type: integer format: int64 description: formaPagamento: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: motivo: type: array items: type: integer format: int64 description: criterioFaturamento: type: string allOf: – #/definitions/criterioFaturamento description: parametrosOrdemCompra: description: allOf: – #/definitions/parametrosBase – type: object properties: transacaoProduto: type: array items: type: integer format: int64 description: transacaoServico: type: array items: type: integer format: int64 description: situacao: type: array items: type: string allOf: – #/definitions/situacaoComercial description: condicaoPagamento: type: array items: type: integer format: int64 description: formaPagamento: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: tipoParcela: type: string allOf: – #/definitions/tipoParcela description: parametrosContratoCompra: description: allOf: – #/definitions/parametrosBase – type: object properties: transacaoProduto: type: array items: type: integer format: int64 description: transacaoServico: type: array items: type: integer format: int64 description: tipoContrato: type: array items: type: string allOf: – #/definitions/tipoContrato description: condicaoPagamento: type: array items: type: integer format: int64 description: formaPagamento: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: motivo: type: array items: type: integer format: int64 description: parametrosContasPagar: description: allOf: – #/definitions/parametrosBase – type: object properties: categoria: type: string allOf: – #/definitions/categoriaTitulos description: calculoFinanceiroTitulos: type: array items: type: string allOf: – #/definitions/calculoFinanceiroTitulos description: tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: situacaoTitulo: type: array items: type: string description: tipoTitulo: type: array items: type: string description: transacaoEntrada: type: array items: type: integer format: int64 description: transacaoBaixa: type: array items: type: integer format: int64 description: grupo: type: array items: type: string description: formaPagamento: type: array items: type: integer format: int64 description: portador: type: array items: type: integer format: int64 description: carteira: type: array items: type: string description: naturezaGastos: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: consideraNaoAprovados: type: boolean description: simulacaoImpostos: type: object allOf: – #/definitions/simulacaoImpostos description: tipoConta: type: array items: type: string description: contaInterna: type: array items: type: integer format: int64 description: tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: consideraVencidos: type: boolean description: considerarDerivativos: type: boolean description: produtoBancario: type: array items: type: integer format: int64 description: parametrosExtratoBancario: description: allOf: – #/definitions/parametrosBase – type: object properties: filtroExtratos: type: string allOf: – #/definitions/filtroExtratos description: tipoConta: type: array items: type: string description: contaInterna: type: array items: type: integer format: int64 description: tipoDocumento: description: type: object required: – id – empresa – documento – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: documento: type: string description: descricao: type: string description: parametrosTesouraria: description: allOf: – #/definitions/parametrosBase – type: object properties: transacao: type: array items: type: integer format: int64 description: tipoConta: type: array items: type: string description: contaInterna: type: array items: type: integer format: int64 description: tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: origemTesouraria: type: array items: type: string allOf: – #/definitions/origemTesouraria description: naturezaGastos: type: array items: type: integer format: int64 description: consideraBloqueado: type: boolean description: tipoDocumento: type: array items: type: integer format: int64 description: situacaoProjeto: description: type: object required: – id – empresa – situacao – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: situacao: type: string description: descricao: type: string description: projeto: description: type: object required: – id – empresa – projeto – nome – abreviatura – situacao – natureza – controlaMes properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: projeto: type: integer format: int64 description: nome: type: string description: abreviatura: type: string description: situacao: type: object allOf: – #/definitions/situacaoProjeto description: natureza: type: string description: controlaMes: type: string description: faseProjeto: description: type: object required: – id – empresa – projetoId – fase – descricao – abreviatura – natureza properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: projetoId: type: object allOf: – #/definitions/projeto description: fase: type: integer format: int64 description: descricao: type: string description: abreviatura: type: string description: natureza: type: string description: contaFinanceira: description: type: object required: – id – contaFinanceira – empresa – abreviatura – classificacao – mascara – natureza properties: id: type: integer format: int64 description: contaFinanceira: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: abreviatura: type: string description: classificacao: type: string description: mascara: type: string description: natureza: type: string description: contaContabil: description: type: object required: – id – contacontabil – empresa – abreviatura – classificacao – mascara – natureza properties: id: type: integer format: int64 description: contacontabil: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: abreviatura: type: string description: classificacao: type: string description: mascara: type: string description: natureza: type: string description: centroCusto: description: type: object required: – id – centroCusto – empresa – abreviatura – classificacao – mascara properties: id: type: integer format: int64 description: centroCusto: type: string description: empresa: type: object allOf: – #/definitions/empresa description: abreviatura: type: string description: classificacao: type: string description: mascara: type: string description: assessoriaCobranca: description: type: object required: – id – empresa – assessoria – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: assessoria: type: integer format: int64 description: descricao: type: string description: faseCobranca: description: type: object required: – id – empresa – assessoria – fase – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: assessoria: type: object allOf: – #/definitions/assessoriaCobranca description: fase: type: integer format: int64 description: descricao: type: string description: parametrosBaseOrcada: description: allOf: – #/definitions/parametrosBase – type: object properties: prazoMedio: type: integer format: int64 description: origemOrcamento: type: string allOf: – #/definitions/origemOrcamento description: origemOrcamentoCentroCustos: type: string allOf: – #/definitions/origemOrcamentoCentroCustos description: origemOrcamentoProjetos: type: string allOf: – #/definitions/origemOrcamentoProjetos description: origemOrcamentoContaFinanceira: type: string allOf: – #/definitions/origemOrcamentoContaFinanceira description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: projeto: type: array items: type: integer format: int64 description: faseProjeto: type: array items: type: integer format: int64 description: contaFinanceira: type: array items: type: integer format: int64 description: contaContabil: type: array items: type: integer format: int64 description: centroCusto: type: array items: type: integer format: int64 description: formaPagamento: type: array items: type: integer format: int64 description: parametrosComissao: description: allOf: – #/definitions/parametrosBase – type: object properties: transacao: type: array items: type: integer format: int64 description: assessoriaCobranca: type: array items: type: integer format: int64 description: faseCobranca: type: array items: type: integer format: int64 description: dataPagamento: type: string format: date description: percentualSimuladas: type: number format: double description: parametrosMovimentosDiversos: description: allOf: – #/definitions/parametrosBase – type: object properties: formaPagamento: type: array items: type: integer format: int64 description: naturezaGastos: type: array items: type: integer format: int64 description: projeto: type: array items: type: integer format: int64 description: faseProjeto: type: array items: type: integer format: int64 description: contaFinanceira: type: array items: type: integer format: int64 description: contaContabil: type: array items: type: integer format: int64 description: centroCusto: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: produtoBancario: description: type: object required: – id – empresa – numero – descricao – geraDiferenca – tipoProduto properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: numero: type: integer format: int64 description: descricao: type: string description: geraDiferenca: type: string description: tipoProduto: type: integer format: int64 description: calculoContratoFinanceiro: description: type: object required: – id – empresa – numero – descricao properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: numero: type: integer format: int64 description: descricao: type: string description: parametrosAplicacaoFinanceira: description: type: object required: – considera properties: considera: type: boolean description: percentual: type: number format: double description: produtoBancario: type: array items: type: integer format: int64 description: calculoContrato: type: array items: type: integer format: int64 description: tipoConta: type: array items: type: string description: contaInterna: type: array items: type: integer format: int64 description: parametrosEmprestimo: description: allOf: – #/definitions/parametrosBase – type: object properties: produtoBancario: type: array items: type: integer format: int64 description: calculoContrato: type: array items: type: integer format: int64 description: contaInterna: type: array items: type: integer format: int64 description: situacaoTitulo: type: array items: type: string description: tipoVencimentoTitulo: type: string allOf: – #/definitions/tipoVencimentoTitulo description: tipoTitulo: type: array items: type: string description: transacao: type: array items: type: integer format: int64 description: grupo: type: array items: type: string description: formaPagamento: type: array items: type: integer format: int64 description: portador: type: array items: type: integer format: int64 description: carteira: type: array items: type: string description: naturezaGastos: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: produtoCorrespondenteBancario: description: type: object required: – id – banco – produto – descricaoProduto properties: id: type: integer format: int64 description: banco: type: object allOf: – #/definitions/banco description: produto: type: integer format: int64 description: descricaoProduto: type: string description: operadorTelefonia: description: type: object required: – id – empresa – operadora – nome properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/empresa description: operadora: type: integer format: int64 description: nome: type: string description: parametrosServicoPontoVenda: description: allOf: – #/definitions/parametrosBase – type: object properties: tipoRecebimento: type: string allOf: – #/definitions/tipoRecebimento description: correspondenteBancario: type: array items: type: string description: produtoCorrespondente: type: array items: type: integer format: int64 description: operadoras: type: array items: type: integer format: int64 description: parametrosBaseHistorica: description: allOf: – #/definitions/parametrosBase – type: object properties: tipoBuscaBaseHistorica: type: string allOf: – #/definitions/tipoBuscaBaseHistorica description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: tipoTitulo: type: array items: type: string description: grupo: type: array items: type: string description: formaPagamento: type: array items: type: integer format: int64 description: portador: type: array items: type: integer format: int64 description: carteira: type: array items: type: string description: transacaoEntrada: type: array items: type: integer format: int64 description: transacaoBaixa: type: array items: type: integer format: int64 description: situacaoTitulo: type: array items: type: string description: buscaVencimentoContasReceber: type: array items: type: string allOf: – #/definitions/buscaVencimentoContasReceber description: tipoVencimento: type: string allOf: – #/definitions/tipoVencimentoTitulo description: tipoValor: type: string allOf: – #/definitions/tipoValor description: transacao: type: array items: type: integer format: int64 description: tipoConta: type: array items: type: string description: contaInterna: type: array items: type: integer format: int64 description: tipoDocumento: type: array items: type: integer format: int64 description: naturezaGastos: type: array items: type: integer format: int64 description: moeda: type: array items: type: string description: tipoBusca: type: string allOf: – #/definitions/tipoBuscaMovimento description: origemTesouraria: type: array items: type: string allOf: – #/definitions/origemTesouraria description: filtroExtratos: type: string allOf: – #/definitions/filtroExtratos description: consultaInformacoesRapida: description: type: object required: – id – descricao properties: id: type: integer format: int64 description: descricao: type: string description: parametrizacao: description: type: object required: – tipoVisao – periodicidade – agrupamento properties: idTemplate: type: integer format: int64 description: descricaoVisao: type: string description: tipoVisao: type: string allOf: – #/definitions/tipoVisao description: periodicidade: type: string allOf: – #/definitions/periodicidade description: periodoFluxo: type: string allOf: – #/definitions/periodoFluxo description: inicioPeriodoFluxoOriginal: type: string format: date description: inicioPeriodoFluxo: type: string format: date description: fimPeriodoFluxo: type: string format: date description: dataBase: type: string format: date description: considerarDiaNaoUtil: type: boolean description: agrupamento: type: string allOf: – #/definitions/agrupamento description: ordenacaoAgrupamento: type: string allOf: – #/definitions/ordenacaoAgrupamento description: limiteCredito: type: object allOf: – #/definitions/limiteCredito description: caixaMinimo: type: string description: somaCaixaLimite: type: boolean description: moeda: type: object allOf: – #/definitions/moedaVisao description: empresa: type: array items: type: integer format: int64 description: agrupamentoFiliais: type: array items: type: integer format: int64 description: filial: type: array items: type: integer format: int64 description: rotinas: type: array items: type: string allOf: – #/definitions/rotinaFluxo description: siglaMoedaEmpresas: type: string description: percentualReceita: type: number format: double description: percentualDespesa: type: number format: double description: origemRealizado: type: string allOf: – #/definitions/origemRealizado description: buscarHistorico: type: string allOf: – #/definitions/baseHistorica description: grafico: type: object allOf: – #/definitions/grafico description: visualizarOrigem: type: boolean description: saldoInicial: type: object allOf: – #/definitions/saldoInicial description: consolidarPorEmpresa: type: boolean description: visualizacaoNiveis: type: string allOf: – #/definitions/enumVisualizacaoNiveis description: visualizacaoNiveisSuperiores: type: string allOf: – #/definitions/enumVisualizacaoNiveis description: pedido: type: object allOf: – #/definitions/parametrosPedido description: receitas contratoVenda: type: object allOf: – #/definitions/parametrosContratoVenda description: contasReceber: type: object allOf: – #/definitions/parametrosContasReceber description: aplicacaoFinanceira: type: object allOf: – #/definitions/parametrosAplicacaoFinanceira description: tesourariaReceita: type: object allOf: – #/definitions/parametrosTesouraria description: baseOrcadaReceita: type: object allOf: – #/definitions/parametrosBaseOrcada description: movimentosDiversosReceita: type: object allOf: – #/definitions/parametrosMovimentosDiversos description: baseHistoricaReceita: type: object allOf: – #/definitions/parametrosBaseHistorica description: distribuirVencidosReceber: type: object allOf: – #/definitions/distribuirVencidos description: extratosBancariosReceita: type: object allOf: – #/definitions/parametrosExtratoBancario description: ordemCompra: type: object allOf: – #/definitions/parametrosOrdemCompra description: despesas contratoCompra: type: object allOf: – #/definitions/parametrosContratoCompra description: contasPagar: type: object allOf: – #/definitions/parametrosContasPagar description: comissao: type: object allOf: – #/definitions/parametrosComissao description: emprestimo: type: object allOf: – #/definitions/parametrosEmprestimo description: servicoPontoVenda: type: object allOf: – #/definitions/parametrosServicoPontoVenda description: tesourariaDespesa: type: object allOf: – #/definitions/parametrosTesouraria description: baseOrcadaDespesa: type: object allOf: – #/definitions/parametrosBaseOrcada description: movimentosDiversosDespesa: type: object allOf: – #/definitions/parametrosMovimentosDiversos description: baseHistoricaDespesa: type: object allOf: – #/definitions/parametrosBaseHistorica description: distribuirVencidosPagar: type: object allOf: – #/definitions/distribuirVencidos description: mostrarNiveisSuperiores: type: boolean description: criteriosBaseHistorica: type: object allOf: – #/definitions/criteriosBaseHistorica description: extratosBancariosDespesa: type: object allOf: – #/definitions/parametrosExtratoBancario description: criteriosBaseHistorica: description: type: object properties: divisao: type: string allOf: – #/definitions/divisaoBaseHistorica description: templateId: type: integer format: int64 description: percentualSobre: type: boolean description: diaUtil: description: type: object required: – nomeCampo – cep – data properties: nomeCampo: type: string description: cep: type: integer format: int64 description: data: type: string format: date description: itensDistribuicao: description: type: object required: – periodoInicial – periodoFinal – percentual properties: periodoInicial: type: integer format: int64 description: periodoFinal: type: integer format: int64 description: percentual: type: number format: double description: caracteristicaRotina: description: type: object required: – considera – rotina – percentual properties: considera: type: boolean description: rotina: type: string allOf: – #/definitions/rotinaAlterada description: percentual: type: number format: double description: lancamentosAgrupamento: description: type: object required: – id – valor – observacao – readOnly properties: id: type: integer format: int64 description: valor: type: string description: observacao: type: string description: readOnly: type: boolean description: percentualAjustado: type: number format: double description: cadastroPercentuais: description: type: object required: – rateioId – data – percentual properties: rateioId: type: integer format: int64 description: data: type: string format: date description: percentual: type: string description: templatePercentualResumido: description: type: object required: – id – descricao – periodicidade – agrupamento properties: id: type: integer format: int64 description: descricao: type: string description: periodicidade: type: string allOf: – #/definitions/periodicidade description: agrupamento: type: string allOf: – #/definitions/agrupamento description: filtroEmpresa: type: string description: usuarioGeracao: type: string description: usuarioAlteracao: type: string description: dataGeracao: type: string format: date-time description: dataAlteracao: type: string format: date-time description: 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 visao: description: type: object required: – descricaoVisao – parametrizacao properties: id: type: integer format: int64 description: descricaoVisao: type: string description: favorita: type: boolean description: usuarioGeracao: type: string description: usuarioAlteracao: type: string description: dataGeracao: type: string format: date-time description: dataAlteracao: type: string format: date-time description: parametrizacao: type: object allOf: – #/definitions/parametrizacao description: movimentoDiverso: description: type: object required: – empresaId – filialId – dataMovimento – tipoMovimento – descricao – valor – visao – tipoAgrupamento properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: dataMovimento: type: string format: date description: tipoMovimento: type: string allOf: – #/definitions/naturezaMovimento description: descricao: type: string description: valor: type: string description: visao: type: string allOf: – #/definitions/tipoVisaoMovimentoDiverso description: tipoAgrupamento: type: array items: type: string allOf: – #/definitions/agrupamento minimum: 1 description: formaPagamentoId: type: array items: type: integer format: int64 description: naturezaGastosId: type: array items: type: integer format: int64 description: projetoId: type: array items: type: integer format: int64 description: faseProjetoId: type: array items: type: integer format: int64 description: contaFinanceiraId: type: array items: type: integer format: int64 description: contaContabilId: type: array items: type: integer format: int64 description: centroCustosId: type: array items: type: integer format: int64 description: moedasId: type: array items: type: integer format: int64 description: dataAlteracao: type: string format: date-time description: criterioDistribuicaoVencidos: description: type: object required: – descricao – tipoDistribuicao – itensDistribuicao properties: id: type: integer format: int64 description: descricao: type: string description: tipoDistribuicao: type: string allOf: – #/definitions/tipoDistribuicao description: itensDistribuicao: type: array items: type: object allOf: – #/definitions/itensDistribuicao minimum: 1 description: dataAlteracao: type: string format: date-time description: lancamentoSimulacao: description: type: object required: – nivelAfetado – valor – observacao properties: id: type: integer format: int64 description: nivelAfetado: type: integer format: int64 description: valor: type: string description: observacao: type: string description: templatePercentual: description: type: object required: – descricao – periodicidade – agrupamento – cadastroPercentuais properties: id: type: integer format: int64 description: descricao: type: string description: periodicidade: type: string allOf: – #/definitions/periodicidade description: agrupamento: type: string allOf: – #/definitions/agrupamento description: cadastroPercentuais: type: array items: type: object allOf: – #/definitions/cadastroPercentuais minimum: 1 description: filtroEmpresa: type: string description: usuarioGeracao: type: string description: usuarioAlteracao: type: string description: dataGeracao: type: string format: date-time description: dataAlteracao: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE