2.0info: 9.4.1 ceb_conciliacaobancaria description: Serviço responsável pela conciliação bancária x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: ceb_conciliacaobancaria contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ceb_conciliacaobancaria/queries/obterAgrupamentosFilial: post: description: Retornar os agrupamentos cadastros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresaId: type: array items: type: integer format: int64 description: Recebe os códigos das empresas selecionadas offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: agrupamentosFilial: type: array items: type: object allOf: – #/definitions/recAgrupamentoFilial description: Retorna uma lista de agrupamentos. Deverá retornar ordenados por:\n agrupamentofilial.empresa_id, agrupamentofilial.agrupamento totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar os agrupamentos cadastros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: Recebe os códigos das empresas selecionadas in: query type: array items: type: integer format: int64 – name: offset description: último item 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 properties: agrupamentosFilial: type: array items: type: object allOf: – #/definitions/recAgrupamentoFilial description: Retorna uma lista de agrupamentos. Deverá retornar ordenados por:\n agrupamentofilial.empresa_id, agrupamentofilial.agrupamento totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterParametrizacao: post: description: Retorna as Parametrizacoes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: parametros: type: array items: type: object allOf: – #/definitions/recParametrizacao description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterUltimosExtratosImportados: post: description: Retorna ultimos extratos importados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: logs: type: array items: type: object allOf: – #/definitions/recLog description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterFiliaisEmpresa: post: description: Retornar as filias por empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresaId: type: array items: type: integer format: int64 description: Recebe os códigos das empresas selecionadas offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: filial: type: array items: type: object allOf: – #/definitions/recFilial description: Retorna uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar as filias por empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: Recebe os códigos das empresas selecionadas in: query type: array items: type: integer format: int64 – name: offset description: último item 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 properties: filial: type: array items: type: object allOf: – #/definitions/recFilial description: Retorna uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterFiliaisContaInterna: post: description: Retornar as filias por contas internas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaInternaId properties: contaInternaId: type: integer format: int64 description: Recebe os códigos das contas internas selecionadas offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: filial: type: array items: type: object allOf: – #/definitions/recFilial description: Retorna uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar as filias por contas internas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: contaInternaId description: Recebe os códigos das contas internas selecionadas in: query required: true type: integer format: int64 – name: offset description: último item 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 properties: filial: type: array items: type: object allOf: – #/definitions/recFilial description: Retorna uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterFiliaisAgrupamento: post: description: Retornar as filias por agrupamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: agrupamentoId: type: array items: type: integer format: int64 description: Recebe os códigos dos agrupamentos selecionados offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: filial: type: array items: type: object allOf: – #/definitions/recFilial description: Retornar uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar as filias por agrupamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: agrupamentoId description: Recebe os códigos dos agrupamentos selecionados in: query type: array items: type: integer format: int64 – name: offset description: último item 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 properties: filial: type: array items: type: object allOf: – #/definitions/recFilial description: Retornar uma lista de filiais. Deverá retornar ordenados por:\n filial.empresa_id, filial.filial totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterEmpresas: post: description: Retornar as empresas. (ordenada pelo id). 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: Recebe as empresas selecionadas offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaEmpresas properties: listaEmpresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retornar uma lista de empresas. Deverá retornar ordenados por: empresa.id totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError get: description: Retornar as empresas. (ordenada pelo id). tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: Recebe as empresas selecionadas in: query type: array items: type: integer format: int64 – name: offset description: último item 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: – listaEmpresas properties: listaEmpresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Retornar uma lista de empresas. Deverá retornar ordenados por: empresa.id totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterTransacaoTesouraria: post: description: Retornar as transações cadastradas 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: Recebe as empresas selecionadas offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada natureza: type: string allOf: – #/definitions/enumNatureza description: natureza da transacão somenteTransferencia: type: boolean description: Somente transacoes que tem uma outra transacao de transferência ligada responses: 200: description: Ok schema: type: object properties: transacao: type: array items: type: object allOf: – #/definitions/recTransacaoTesouraria description: Lista de transacoes ordenada pelo id da empresa e codigo da transacao totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterContasPorId: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaId properties: contaId: type: array items: type: integer format: int64 minimum: 1 description: responses: 200: description: Ok schema: type: object properties: dadosContaInterna: type: array items: type: object allOf: – #/definitions/recDadosContaInterna description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: contaId description: in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object properties: dadosContaInterna: type: array items: type: object allOf: – #/definitions/recDadosContaInterna description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterContaInterna: post: description: Retornar as contas internas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – offset – quantidade properties: contaInternaId: type: array items: type: integer format: int64 description: Recebe as empresas selecionadas empresaId: type: array items: type: integer format: int64 description: filialId: type: array items: type: integer format: int64 description: agenciaId: type: array items: type: integer format: int64 description: tipoContaId: type: array items: type: string description: Tipo da conta bancoId: type: array items: type: string description: Recebe o código do banco termoBusca: type: string description: offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada tipoFiltroConta: type: string allOf: – #/definitions/tipoFiltroConta description: Considerar tipos de contas consideraInativas: type: boolean description: Indicativo se é para retornar contas inativas responses: 200: description: Ok schema: type: object properties: dadosContaInterna: type: array items: type: object allOf: – #/definitions/recDadosContaInterna description: Listagem da conta ordenado pela id da empresa e codigo da conta totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterListaBancos: post: description: Retornar a lista de bancos pré-cadastrados – tabela lista_banco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: termoBusca: type: string description: responses: 200: description: Ok schema: type: object required: – listaBanco – totalRegistros properties: listaBanco: type: array items: type: object allOf: – #/definitions/recBanco minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: Retornar a lista de bancos pré-cadastrados – tabela lista_banco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: termoBusca description: in: query type: string responses: 200: description: Ok schema: type: object required: – listaBanco – totalRegistros properties: listaBanco: type: array items: type: object allOf: – #/definitions/recBanco minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterBancosCadastrados: post: description: Retornar a lista de bancos cadastrados na tabela banco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – paginacao properties: termoBusca: type: string description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – listaBanco – paginacaoRetorno properties: listaBanco: type: array items: type: object allOf: – #/definitions/recBanco minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterAgencias: post: description: Retornar a lista de agencias cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: bancoId: type: array items: type: string description: agenciaId: type: array items: type: integer format: int64 description: termoBusca: type: string description: offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaAgencia properties: listaAgencia: type: array items: type: object allOf: – #/definitions/recAgencia minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: Retornar a lista de agencias cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: bancoId description: in: query type: array items: type: string – name: agenciaId description: in: query type: array items: type: integer format: int64 – name: termoBusca description: in: query type: string – name: offset description: último item 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: – listaAgencia properties: listaAgencia: type: array items: type: object allOf: – #/definitions/recAgencia minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterMoedas: post: description: Buscar moedas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – listaMoedas properties: listaMoedas: type: array items: type: object allOf: – #/definitions/recListaMoeda minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Buscar moedas tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – listaMoedas properties: listaMoedas: type: array items: type: object allOf: – #/definitions/recListaMoeda minimum: 1 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterNaturezaGasto: post: description: Retornar Natureza de gasto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – offset – quantidade properties: empresaId: type: array items: type: integer format: int64 minimum: 1 description: offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object required: – listaNatureza properties: listaNatureza: type: array items: type: object allOf: – #/definitions/recListaNaturezaGasto minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: Retornar Natureza de gasto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: offset description: último item 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: – listaNatureza properties: listaNatureza: type: array items: type: object allOf: – #/definitions/recListaNaturezaGasto minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterExtratosBancarios: post: description: Buscar as informações do extrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – offset – quantidade properties: id: type: array items: type: integer format: int64 description: empresaId: type: array items: type: integer format: int64 description: filialId: type: array items: type: integer format: int64 description: tipoContaId: type: array items: type: string description: contaInternaId: type: array items: type: integer format: int64 description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: extratosBancario: type: array items: type: object allOf: – #/definitions/recExtratoBancario description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterLancamentosExtratoBancario: post: description: Buscar a composição do extrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaInternaId – exibir – natureza – paginacao properties: contaInternaId: type: integer format: int64 description: categoriaId: type: array items: type: integer format: int64 description: exibir: type: string allOf: – #/definitions/enumExibirExtratos description: natureza: type: string allOf: – #/definitions/enumNatureza description: valorInicial: type: string description: valorFinal: type: string description: historico: type: string description: numeroDocumento: type: string description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: filtrarData: type: string allOf: – #/definitions/enumFiltrarDataExtrato description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: movimentoBancario: type: array items: type: object allOf: – #/definitions/recMovimentoExtratoBancario description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterLancamentosExtratoBancarioContaInterna: post: description: Buscar a composição do extrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaInternaId – natureza – exibirPor – paginacao properties: contaInternaId: type: integer format: int64 description: categoriaId: type: array items: type: integer format: int64 description: natureza: type: string allOf: – #/definitions/enumNatureza description: valorInicial: type: string description: valorFinal: type: string description: historico: type: string description: exibirPor: type: string allOf: – #/definitions/enumExibirExtratos description: numeroDocumento: type: string description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: filtrarData: type: string allOf: – #/definitions/enumFiltrarDataExtrato description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – paginacaoRetorno properties: movimentoBancario: type: array items: type: object allOf: – #/definitions/recMovimentoExtratoBancario description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterMovimentosContaInterna: post: description: Buscar as movimentações da conta interna tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – periodoInicial – periodoFinal – offset – quantidade properties: empresaId: type: array items: type: integer format: int64 description: filialId: type: array items: type: integer format: int64 description: tipoContaId: type: array items: type: string description: contaInternaId: type: array items: type: integer format: int64 description: categoriaId: type: array items: type: integer format: int64 description: filtrarData: type: string allOf: – #/definitions/enumFiltrarData description: exibirPor: type: string allOf: – #/definitions/enumExibirPor description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: isRetornarPreparacoes: type: boolean description: Indicativo para retornar ou não movimentos da tesouraria que foram somente preparados (e não foram processados ainda). O padrão é false (retorna tanto movimentos processados como preparações) considerarPeriodoFilial: type: boolean description: default: false offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada listaOrdenacao: type: array items: type: object allOf: – #/definitions/recListaOrdenacao description: responses: 200: description: Ok schema: type: object properties: movimentoContaInterna: type: array items: type: object allOf: – #/definitions/recMovimentoContaInterna description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterSaldoExtratos: post: description: Calcula o saldo dos extratos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaInternaId – filtrarData – exibirPor – periodoInicial – periodoFinal properties: contaInternaId: type: integer format: int64 description: categoriaId: type: array items: type: integer format: int64 description: filtrarData: type: string allOf: – #/definitions/enumFiltrarDataExtrato description: exibirPor: type: string allOf: – #/definitions/enumExibirPor description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: responses: 200: description: Ok schema: type: object required: – saldo – natureza properties: saldo: type: string description: natureza: type: string allOf: – #/definitions/enumNatureza description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterCategoriaExtrato: post: description: Buscar categorias do lançamento do extrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – offset – quantidade properties: termoBusca: type: string description: offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: categorias: type: array items: type: object allOf: – #/definitions/recCategoriaExtrato description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: Buscar categorias do lançamento do extrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: termoBusca description: in: query type: string – name: offset description: último item 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 properties: categorias: type: array items: type: object allOf: – #/definitions/recCategoriaExtrato description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterTipoConta: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – offset – quantidade properties: termoBusca: type: string description: offset: type: integer format: int64 description: último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: tipoConta: type: array items: type: object allOf: – #/definitions/recTipoConta description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: termoBusca description: in: query type: string – name: offset description: último item 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 properties: tipoConta: type: array items: type: object allOf: – #/definitions/recTipoConta description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterMovimentoContaTermoBusca: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – termoBusca – contaInternaId – filtrarData – periodoInicial – periodoFinal – natureza – paginacao properties: termoBusca: type: string description: contaInternaId: type: integer format: int64 description: filtrarData: type: string allOf: – #/definitions/enumFiltrarData description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: natureza: type: string allOf: – #/definitions/enumNatureza description: filialId: type: array items: type: integer format: int64 description: Indicativo de quais filiais os movimentos serão considerados categoriaId: type: array items: type: integer format: int64 description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – records – paginacaoRetorno properties: records: type: array items: type: object allOf: – #/definitions/recMovimentoContaInterna minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterLotes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – filialId – contaInternaId – dataConciliacaoInicial – dataConciliacaoFinal – paginacao properties: empresaId: type: array items: type: integer format: int64 minimum: 1 description: filialId: type: array items: type: integer format: int64 minimum: 1 description: bancoId: type: array items: type: string description: agenciaId: type: array items: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: tipoContaId: type: array items: type: string description: dataConciliacaoInicial: type: string format: date description: dataConciliacaoFinal: type: string format: date description: origemConciliacao: type: string allOf: – #/definitions/enumOrigemLoteFiltro description: situacaoLote: type: string allOf: – #/definitions/enumSituacaoLoteFiltro description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – records – paginacaoRetorno properties: records: type: array items: type: object allOf: – #/definitions/recLoteConciliado minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterMovimentosContaLote: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteId – paginacao properties: loteId: type: string description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – records – paginacaoRetorno properties: records: type: array items: type: object allOf: – #/definitions/recMovimentoContaInterna minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterExtratosLote: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteId – paginacao properties: loteId: type: string description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – records – paginacaoRetorno properties: records: type: array items: type: object allOf: – #/definitions/recMovimentoExtratoBancario minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterMovimentoExtratoTermoBusca: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – termoBusca – contaInternaId – filtrarData – exibirPor – periodoInicial – periodoFinal – natureza – paginacao properties: termoBusca: type: string description: contaInternaId: type: integer format: int64 description: categoriaId: type: array items: type: integer format: int64 description: filtrarData: type: string allOf: – #/definitions/enumFiltrarDataExtrato description: exibirPor: type: string allOf: – #/definitions/enumExibirExtratos description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: natureza: type: string allOf: – #/definitions/enumNatureza description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – records – paginacaoRetorno properties: records: type: array items: type: object allOf: – #/definitions/recMovimentoExtratoBancario minimum: 1 description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterTotaisExtratos: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaInternaId – periodoTotais properties: contaInternaId: type: integer format: int64 description: periodoTotais: type: string allOf: – #/definitions/periodoTotais description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: considerarSomentePendentes: type: boolean description: categoriaId: type: array items: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – periodoInicial – periodoFinal properties: totalCredito: type: string description: totalDebito: type: string description: totalPendenteCredito: type: string description: totalPendenteDebito: type: string description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/obterTotaisMovimentos: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaInternaId – periodoTotais properties: contaInternaId: type: integer format: int64 description: periodoTotais: type: string allOf: – #/definitions/periodoTotais description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: considerarSomentePendentes: type: boolean description: isRetornarPreparacoes: type: boolean description: Indicativo para retornar ou não movimentos da tesouraria que foram somente preparados (e não foram processados ainda). O padrão é false (retorna tanto movimentos processados como preparações) filialId: type: array items: type: integer format: int64 description: Indicativo de quais filiais os movimentos serão considerados categoriaId: type: array items: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – periodoInicial – periodoFinal properties: totalCredito: type: string description: totalDebito: type: string description: totalPendenteCredito: type: string description: totalPendenteDebito: type: string description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/buscarLoteConciliacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: responses: 200: description: Ok schema: type: object properties: loteConciliado: type: object allOf: – #/definitions/recLoteConciliado description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: in: query required: true type: string responses: 200: description: Ok schema: type: object properties: loteConciliado: type: object allOf: – #/definitions/recLoteConciliado description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/buscarLoteTransferencia: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteTransferenciaId properties: loteTransferenciaId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – statusIntegracao properties: statusIntegracao: type: string allOf: – #/definitions/enumStatusIntegracao description: logIntegracao: type: string description: movimentoOrigemId: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: loteTransferenciaId description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – statusIntegracao properties: statusIntegracao: type: string allOf: – #/definitions/enumStatusIntegracao description: logIntegracao: type: string description: movimentoOrigemId: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/possuiIntegracaoG5: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – possuiIntegracaoG5 properties: possuiIntegracaoG5: type: boolean description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – possuiIntegracaoG5 properties: possuiIntegracaoG5: type: boolean description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/atualizarTransacaoTesouraria: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoTesourariaId properties: transacaoTesourariaId: type: integer format: int64 description: categoriaId: type: integer format: int64 description: transacaoTransferenciaId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: string description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/gerarConciliacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – efetiva properties: movimentoConta: type: array items: type: integer format: int64 description: movimentoExtrato: type: array items: type: integer format: int64 description: dataConciliacao: type: string format: date description: efetiva: type: boolean description: responses: 200: description: Ok schema: type: object required: – lote properties: lote: type: object allOf: – #/definitions/recLoteConciliado description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/conciliacaoPorRegra: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – contaId properties: parametrizacaoId: type: integer format: int64 description: parametros: type: object allOf: – #/definitions/recParametros description: viaAgendador: type: boolean description: contaId: type: array items: type: integer format: int64 minimum: 1 description: responses: 200: description: Ok schema: type: object required: – idConciliacaoRegra properties: idConciliacaoRegra: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/gerarDesconciliacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteConciliacao properties: loteConciliacao: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object required: – status properties: status: type: array items: type: object allOf: – #/definitions/statusDesconciliacao minimum: 1 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/importarExtratoBancario: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arquivos properties: arquivos: type: array items: type: object allOf: – #/definitions/recArquivo minimum: 1 description: responses: 200: description: Ok schema: type: object required: – log – contas properties: log: type: array items: type: integer format: int64 minimum: 1 description: contas: type: array items: type: integer format: int64 minimum: 1 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/excluirMovimentoConta: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/excluirMovimentoExtrato: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/importarCNAB240: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arquivo properties: arquivo: type: object allOf: – #/definitions/recArquivo description: responses: 200: description: Ok schema: type: object required: – log – contas properties: log: type: integer format: int64 description: contas: type: array items: type: integer format: int64 minimum: 1 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/alterarSituacaoLote: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteId properties: loteId: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object required: – lotes properties: lotes: type: array items: type: object allOf: – #/definitions/recLoteConciliado minimum: 1 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/verificarStatusConciliacaoRegra: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conciliacaoRegraId – paginacao properties: conciliacaoRegraId: type: integer format: int64 description: paginacao: type: object allOf: – #/definitions/recPaginacao description: responses: 200: description: Ok schema: type: object required: – status – paginacaoRetorno properties: status: type: string allOf: – #/definitions/statusConciliacaoRegra description: logErro: type: string description: lotes: type: array items: type: object allOf: – #/definitions/recLoteConciliado description: paginacaoRetorno: type: object allOf: – #/definitions/recPaginacaoRetorno description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/verificarStatusImportacao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – logImportacaoId properties: logImportacaoId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – status – erro properties: status: type: string allOf: – #/definitions/statusImportacao description: erro: type: string description: relatorio: type: string format: byte description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/gerarTransferencia: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoId – data – natureza – transferenciaOrigem – transferenciasDestino properties: transacaoId: type: integer format: int64 description: data: type: string format: date description: natureza: type: string allOf: – #/definitions/enumNatureza description: transferenciaOrigem: type: object allOf: – #/definitions/recTransferencia description: transferenciasDestino: type: array items: type: object allOf: – #/definitions/recTransferencia minimum: 1 description: responses: 200: description: Ok schema: type: object required: – loteTransferenciaId properties: loteTransferenciaId: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/gerarTransferenciaIntegracao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transferenciaOrigemId – transferenciasDestinoId properties: transferenciaOrigemId: type: integer format: int64 description: transferenciasDestinoId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – transferenciaId properties: transferenciaId: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/estornarTransferenciaIntegracao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transferenciaOrigemId properties: transferenciaOrigemId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: string description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/alterarMovimentoExtratoBancario: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recMovimentoExtratoBancario properties: fieldsChanges: type: array items: type: string description: recMovimentoExtratoBancario: type: object allOf: – #/definitions/recMovimentoExtratoBancarioAlteracao description: responses: 200: description: Ok schema: type: object required: – recMovimentoExtratoBancario properties: recMovimentoExtratoBancario: type: object allOf: – #/definitions/recMovimentoExtratoBancarioAlteracao description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/alterarMovimentoContaInterna: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recMovimentoContaInterna properties: fieldsChanges: type: array items: type: string description: recMovimentoContaInterna: type: object allOf: – #/definitions/recMovimentoContaInternaAlteracao description: responses: 200: description: Ok schema: type: object required: – recMovimentoContaInterna properties: recMovimentoContaInterna: type: object allOf: – #/definitions/recMovimentoContaInternaAlteracao description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/inativarMovimentoContaInterna: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/actions/inserirMovimentosContaInterna: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – movimentos properties: movimentos: type: array items: type: object allOf: – #/definitions/entMovimentoContaInterna minimum: 1 description: responses: 200: description: Ok schema: type: object required: – movimentosIncluidosId properties: movimentosIncluidosId: type: array items: type: integer format: int64 minimum: 1 description: default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/signals/gerarAutoCorrectConciliacao: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: contaInternaId: type: array items: type: integer format: int64 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/signals/gerarAutoCorrectConciliacaoPorContaInterna: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – contaInternaId properties: contaInternaId: type: integer format: int64 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/signals/gerarAutoCorrectConciliacaoPorEstrutura: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – contaInternaId – tipoAutoCorrect properties: contaInternaId: type: integer format: int64 description: tipoAutoCorrect: type: string allOf: – #/definitions/enumTipoAutoCorrect description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/signals/importacaoConciliacaoAgendado: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: parametrizacaoId: type: integer format: int64 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entEmpresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entEmpresa responses: 200: description: The created resource schema: #/definitions/entEmpresa 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/entEmpresa responses: 200: description: The created resource schema: #/definitions/entEmpresa 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/entEmpresa default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entEmpresa/{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/entEmpresa responses: 200: description: Ok schema: #/definitions/entEmpresa 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/entEmpresa responses: 200: description: Ok schema: #/definitions/entEmpresa 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/entEmpresa default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entEmpresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entEmpresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entFilial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entFilial responses: 200: description: The created resource schema: #/definitions/entFilial 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/entFilial responses: 200: description: The created resource schema: #/definitions/entFilial 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/entFilial default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entFilial/{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/entFilial responses: 200: description: Ok schema: #/definitions/entFilial 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/entFilial responses: 200: description: Ok schema: #/definitions/entFilial 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/entFilial default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entFilial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entFilial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entParametro: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entParametro responses: 200: description: The created resource schema: #/definitions/entParametro 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/entParametro responses: 200: description: The created resource schema: #/definitions/entParametro 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/entParametro default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entParametro/{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/entParametro responses: 200: description: Ok schema: #/definitions/entParametro 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/entParametro responses: 200: description: Ok schema: #/definitions/entParametro 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/entParametro default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entParametro/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entParametro responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entBanco: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entBanco responses: 200: description: The created resource schema: #/definitions/entBanco 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/entBanco responses: 200: description: The created resource schema: #/definitions/entBanco 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/entBanco default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entBanco/{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/entBanco responses: 200: description: Ok schema: #/definitions/entBanco 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/entBanco responses: 200: description: Ok schema: #/definitions/entBanco 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/entBanco default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entBanco/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entBanco responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entAgencia: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entAgencia responses: 200: description: The created resource schema: #/definitions/entAgencia 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/entAgencia responses: 200: description: The created resource schema: #/definitions/entAgencia 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/entAgencia default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entAgencia/{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/entAgencia responses: 200: description: Ok schema: #/definitions/entAgencia 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/entAgencia responses: 200: description: Ok schema: #/definitions/entAgencia 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/entAgencia default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entAgencia/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entAgencia responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entContaInterna: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entContaInterna responses: 200: description: The created resource schema: #/definitions/entContaInterna 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/entContaInterna responses: 200: description: The created resource schema: #/definitions/entContaInterna 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/entContaInterna default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entContaInterna/{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/entContaInterna responses: 200: description: Ok schema: #/definitions/entContaInterna 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/entContaInterna responses: 200: description: Ok schema: #/definitions/entContaInterna 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/entContaInterna default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entContaInterna/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entContaInterna responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entMovimentoContaInterna: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entMovimentoContaInterna responses: 200: description: The created resource schema: #/definitions/entMovimentoContaInterna 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/entMovimentoContaInterna responses: 200: description: The created resource schema: #/definitions/entMovimentoContaInterna 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/entMovimentoContaInterna default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entMovimentoContaInterna/{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/entMovimentoContaInterna responses: 200: description: Ok schema: #/definitions/entMovimentoContaInterna 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/entMovimentoContaInterna responses: 200: description: Ok schema: #/definitions/entMovimentoContaInterna 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/entMovimentoContaInterna default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entMovimentoContaInterna/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entMovimentoContaInterna responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entExtratoBancario: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entExtratoBancario responses: 200: description: The created resource schema: #/definitions/entExtratoBancario 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/entExtratoBancario responses: 200: description: The created resource schema: #/definitions/entExtratoBancario 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/entExtratoBancario default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entExtratoBancario/{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/entExtratoBancario responses: 200: description: Ok schema: #/definitions/entExtratoBancario 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/entExtratoBancario responses: 200: description: Ok schema: #/definitions/entExtratoBancario 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/entExtratoBancario default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entExtratoBancario/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entExtratoBancario responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entMovimentoExtratoBancario: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entMovimentoExtratoBancario responses: 200: description: The created resource schema: #/definitions/entMovimentoExtratoBancario 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/entMovimentoExtratoBancario responses: 200: description: The created resource schema: #/definitions/entMovimentoExtratoBancario 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/entMovimentoExtratoBancario default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entMovimentoExtratoBancario/{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/entMovimentoExtratoBancario responses: 200: description: Ok schema: #/definitions/entMovimentoExtratoBancario 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/entMovimentoExtratoBancario responses: 200: description: Ok schema: #/definitions/entMovimentoExtratoBancario 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/entMovimentoExtratoBancario default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entMovimentoExtratoBancario/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entMovimentoExtratoBancario responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entSegmentoBanco: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entSegmentoBanco responses: 200: description: The created resource schema: #/definitions/entSegmentoBanco 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/entSegmentoBanco responses: 200: description: The created resource schema: #/definitions/entSegmentoBanco 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/entSegmentoBanco default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entSegmentoBanco/{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/entSegmentoBanco responses: 200: description: Ok schema: #/definitions/entSegmentoBanco 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/entSegmentoBanco responses: 200: description: Ok schema: #/definitions/entSegmentoBanco 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/entSegmentoBanco default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /ceb_conciliacaobancaria/entities/entSegmentoBanco/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entSegmentoBanco responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumFiltrarData: description: type: string enum: – DataLiberacao – DataMovimento enumStatusImportacao: description: type: string enum: – Processando – Finalizado – Erro – FinalizadoComErros enumOrigemLoteConciliacao: description: type: string enum: – ConciliacaoManual – ConciliacaoPorRegraDataDocumentoValor – ConciliacaoPorRegraDataValor – ConciliacaoPorRegraDocumentoValor – ConciliacaoPorRegraMovimentoEstornado – ConciliacaoPorRegraExtratoEstornado – ConciliacaoViaIntegracao – ConciliacaoPorRegraDataDocumentoAgrupado – ConciliacaoPorRegraDocumentoAgrupado – ConciliacaoPorRegraDataChaveLoteAgrupado – ConciliacaoPorRegraChaveLoteAgrupado enumRegra: description: type: string enum: – RegraDataDocumentoValor – RegraDataValor – RegraDocumentoValor – RegraMovimentoEstornado – RegraExtratoEstornado – RegraDataDocumentoAgrupado – RegraDocumentoAgrupado – RegraDataChaveLoteAgrupado – RegraChaveLoteAgrupado enumSituacaoLoteConciliacao: description: type: string enum: – AguardandoEfetivacao – Efetivo – Estornado – Legado enumSituacaoLoteFiltro: description: type: string enum: – AguardandoEfetivacao – Efetivo – Todos enumOrigemLoteFiltro: description: type: string enum: – ConciliacaoManual – ConciliacaoPorRegraDataDocumentoValor – ConciliacaoPorRegraDataValor – ConciliacaoPorRegraDocumentoValor – ConciliacaoPorRegraMovimentoEstornado – ConciliacaoPorRegraExtratoEstornado – ConciliacaoViaIntegracao – ConciliacaoPorRegraDataDocumentoAgrupado – ConciliacaoPorRegraDocumentoAgrupado – ConciliacaoPorRegraDataChaveLoteAgrupado – ConciliacaoPorRegraChaveLoteAgrupado – Todos enumFiltrarDataExtrato: description: type: string enum: – DataEfetivacao – DataLancamento enumExibirPor: description: type: string enum: – Conciliados – NaoConciliados – SoSaldos – Todos – NaoConciliadosSemSaldo – SoSaldosConciliados – TodosSemSaldoAnterior enumExibirExtratos: description: type: string enum: – Conciliados – NaoConciliados – Todos enumOrigemExtrato: description: type: string enum: – Digitado – Importado – Todos enumNatureza: description: type: string enum: – Credito – Debito – Todos enumTipoOrdenacao: description: type: string enum: – Asc – Desc statusConciliacaoRegra: description: type: string enum: – Processando – Finalizado – FinalizadoComErros statusImportacao: description: type: string enum: – Processando – Finalizado – Erro – FinalizadoComErros enumTipoAutoCorrect: description: type: string enum: – MovimentoVsMovimento – ExtratoVsExtrato – MovimentoVsExtrato periodoTotais: description: type: string enum: – EstaSemana – EstaQuinzena – EsteMes – EsteBimestre – EsteTrimestre – EsteSemestre – EsteAno – PeriodoDeAte enumSituacao: description: type: string enum: – ATIVO – INATIVO enumErpFinTesTesourariaNatureza: description: type: string enum: – CREDITO – DEBITO enumErpFinTesTesourariaSituacao: description: type: string enum: – ATIVO – INATIVO tipoFiltroConta: description: type: string enum: – BANCARIAS – NAO_BANCARIAS – TODAS enumStatusIntegracao: description: type: string enum: – INTEGRADO – EM_INTEGRACAO – ERRO_INTEGRACAO enumTipoLancamento: description: type: string enum: – MANUAL – AUTOMATICO 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 recParametrizacao: description: type: object required: – id properties: id: type: integer format: int64 description: descricao: type: string description: favorita: type: boolean description: json: type: object allOf: – #/definitions/recParametros description: dataGeracao: type: string format: date-time description: usuarioGeracao: type: string description: dataAlteracao: type: string format: date-time description: usuarioAlteracao: type: string description: recLog: description: type: object required: – id properties: id: type: integer format: int64 description: nomeArquivo: type: string description: data: type: string format: date description: hora: type: string description: recLoteConciliado: description: type: object required: – id properties: id: type: string description: dataConciliacao: type: string format: date-time description: origemConciliacao: type: string allOf: – #/definitions/enumOrigemLoteConciliacao description: situacao: type: string allOf: – #/definitions/enumSituacaoLoteConciliacao description: totalMovCredito: type: string description: totalMovDebito: type: string description: totalExtCredito: type: string description: totalExtDebito: type: string description: quantidadeMovimentos: type: integer format: int64 description: quantidadeExtratos: type: integer format: int64 description: valorConciliado: type: string description: contaInternaId: type: integer format: int64 description: possuiUltimaTransferencia: type: boolean description: statusIntegracao: type: string allOf: – #/definitions/enumStatusIntegracao description: logIntegracao: type: string description: dataAlteracao: type: string format: date-time description: usuarioAlteracao: type: string description: recParametros: description: type: object required: – dataMovimento – dataExtrato properties: efetivaConciliacaoPorRegra: type: boolean description: empresa: type: array items: type: integer format: int64 description: agrupamento: type: array items: type: integer format: int64 description: filial: type: array items: type: integer format: int64 description: banco: type: array items: type: string description: agencia: type: array items: type: integer format: int64 description: conta: type: array items: type: integer format: int64 description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: conciliacaoPorRegras: type: array items: type: string allOf: – #/definitions/enumRegra description: efetivaConciliacao: type: boolean description: natureza: type: string allOf: – #/definitions/enumNatureza description: dataMovimento: type: string allOf: – #/definitions/enumFiltrarData description: transacao: type: array items: type: integer format: int64 description: dataExtrato: type: string allOf: – #/definitions/enumFiltrarDataExtrato description: categoria: type: array items: type: integer format: int64 description: consideraCategoria: type: boolean description: quantidadeDias: type: integer format: int64 description: recArquivo: description: type: object required: – arquivo – nome properties: arquivo: type: string format: byte description: nome: type: string description: recPaginacaoRetorno: description: type: object required: – pagina – numeroRegistrosPagina – registrosEncontrados properties: pagina: type: integer format: int64 description: numeroRegistrosPagina: type: integer format: int64 description: registrosEncontrados: type: integer format: int64 description: recUsuario: description: type: object required: – paramRotinaId – usuario properties: paramRotinaId: type: integer format: int64 description: id da tabela conciliacao_param_rotina usuario: type: string description: usuario logado no sistema dataGeracao: type: string format: date-time description: usuarioGeracao: type: string description: dataAlteracao: type: string format: date-time description: usuarioAlteracao: type: string description: situacao: type: boolean description: recAgrupamentoFilial: description: type: object required: – agrupamentoId – codigo – descricao properties: agrupamentoId: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/recEmpresa description: codigo: type: integer format: int64 description: descricao: type: string description: recFilial: description: type: object required: – id – empresaId – filial – nome – cidade – estado properties: id: type: integer format: int64 description: empresaId: type: object allOf: – #/definitions/recEmpresa description: filial: type: integer format: int64 description: agrupamento: type: object allOf: – #/definitions/recAgrupamentoFilial description: nome: type: string description: cidade: type: string description: estado: type: string description: recEmpresa: description: type: object required: – id – nomeFantasia properties: id: type: integer format: int64 description: nomeFantasia: type: string description: recContaInterna: description: type: object required: – contaInternaId – empresa – codigoContaInterna – abreviaturaContaInterna – descricaoContaInterna – agruparNovosMovimentos properties: contaInternaId: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/recEmpresa description: codigoContaInterna: type: string description: abreviaturaContaInterna: type: string description: descricaoContaInterna: type: string description: agruparNovosMovimentos: type: boolean description: filial: type: array items: type: object allOf: – #/definitions/recFilial description: recTransacaoTesouraria: description: type: object required: – transacaoId – empresa – transacao – descricaoTransacao properties: transacaoId: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/recEmpresa description: transacao: type: string description: descricaoTransacao: type: string description: categoriaId: type: integer format: int64 description: descricaoCategoria: type: string description: natureza: type: string allOf: – #/definitions/enumNatureza description: transacaoTransferencia: type: object allOf: – #/definitions/recTransacaoTesouraria description: recNaturezaGasto: description: type: object required: – empresa properties: naturezaGastoId: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/recEmpresa description: codigoNaturezaGasto: type: integer format: int64 description: descricaoNaturezaGasto: type: string description: recDadosContaInterna: description: type: object required: – id – empresa – filial – contaInterna – descricao – abreviatura – tipoConta – agencia – banco – agruparNovosMovimentos properties: id: type: integer format: int64 description: empresa: type: object allOf: – #/definitions/recEmpresa description: filial: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: contaInterna: type: string description: descricao: type: string description: abreviatura: type: string description: tipoConta: type: object allOf: – #/definitions/recTipoConta description: agencia: type: object allOf: – #/definitions/recAgencia description: banco: type: object allOf: – #/definitions/recBanco description: agruparNovosMovimentos: type: boolean description: recTipoConta: description: type: object required: – id – descricao – aplicacao properties: id: type: string description: descricao: type: string description: aplicacao: type: integer format: int64 description: recAgencia: description: type: object required: – id – bancoId – banco – agencia – descricao properties: id: type: integer format: int64 description: bancoId: type: string description: banco: type: string description: agencia: type: string description: descricao: type: string description: recBanco: description: type: object required: – bancoId – nomeBanco – segmento properties: bancoId: type: string description: nomeBanco: type: string description: segmento: type: string description: logoMarca: type: string description: cnpj: type: integer format: int64 description: recListaMoeda: description: type: object required: – moedaId – descricao – sigla properties: moedaId: type: string description: descricao: type: string description: sigla: type: string description: recListaNaturezaGasto: description: type: object required: – naturezaGastoId – naturezaGasto – descricao properties: naturezaGastoId: type: integer format: int64 description: naturezaGasto: type: integer format: int64 description: descricao: type: string description: recComposicaoExtrato: description: type: object required: – id – empresa – contaInterna – descricao – origemExtrato – lancamentos properties: id: type: integer format: int64 description: empresa: type: integer format: int64 description: contaInterna: type: string description: descricao: type: string description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: lancamentos: type: array items: type: object allOf: – #/definitions/recLancamentoExtratoBancario minimum: 1 description: recLancamentoExtratoBancario: description: type: object required: – id – natureza – dataEfetivacao – dataLancamento properties: id: type: integer format: int64 description: natureza: type: string allOf: – #/definitions/enumNatureza description: complementoLancamento: type: string description: dataEfetivacao: type: string format: date description: dataLancamento: type: string format: date description: valorLancamento: type: string description: categoriaId: type: integer format: int64 description: codigoHistorico: type: string description: historico: type: string description: sequencia: type: integer format: int64 description: numeroDocumento: type: string description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recExtratoBancario: description: type: object required: – id – contaInternaId – abreviaturaContaInterna – descricao – loteServico – dataInicioSaldo – saldoInicio – dataFinalSaldo – saldoFinal – origemExtrato – usuarioGerador – dataGeracao – usuarioAlteracao – dataAlteracao properties: id: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: abreviaturaContaInterna: type: string description: descricao: type: string description: loteServico: type: integer format: int64 description: dataInicioSaldo: type: string format: date description: saldoInicio: type: string description: dataFinalSaldo: type: string format: date description: saldoFinal: type: string description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recExtratoBancarioAlteracao: description: type: object required: – id properties: id: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: descricao: type: string description: loteServico: type: integer format: int64 description: dataInicioSaldo: type: string format: date description: saldoInicio: type: string description: dataFinalSaldo: type: string format: date description: saldoFinal: type: string description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recMovimentoExtratoBancarioAlteracao: description: type: object required: – id properties: id: type: integer format: int64 description: extratoBancarioId: type: integer format: int64 description: natureza: type: string allOf: – #/definitions/enumNatureza description: complementoLancamento: type: string description: dataEfetivacao: type: string format: date description: dataLancamento: type: string format: date description: valorLancamento: type: string description: categoriaId: type: integer format: int64 description: codigoHistorico: type: string description: sequencia: type: integer format: int64 description: historico: type: string description: numeroDocumento: type: string description: loteConciliacaoId: type: string description: contaInternaId: type: integer format: int64 description: identificacaoBancaria: type: string description: origemConciliacao: type: string description: dataConciliacao: type: string format: date description: sequenciaConciliacao: type: integer format: int64 description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recMovimentoContaInternaAlteracao: description: type: object required: – id properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: dataMovimento: type: string format: date description: dataLiberacao: type: string format: date description: transacaoId: type: integer format: int64 description: naturezaGastoId: type: integer format: int64 description: numeroDocumento: type: string description: sequenciaMovimento: type: integer format: int64 description: historico: type: string description: numeroCheque: type: integer format: int64 description: observacao: type: string description: chaveLote: type: string description: loteContabil: type: integer format: int64 description: loteBaixa: type: integer format: int64 description: natureza: type: string allOf: – #/definitions/enumNatureza description: valor: type: string description: valorMoeda: type: string description: origemMovimento: type: string description: loteConciliacaoId: type: string description: movimentoExtratoOrigem: type: array items: type: integer format: int64 description: situacao: type: string allOf: – #/definitions/enumSituacao description: tipoLancamento: type: string description: sequenciaConciliacao: type: integer format: int64 description: origemConciliacao: type: string description: dataConciliacao: type: string format: date description: sequenciaPreparacao: type: string description: dataPrevisaoPagamento: type: string format: date description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: validarPeriodo: type: boolean description: recMovimentoExtratoBancario: description: type: object required: – id – extratoBancarioId – natureza – complementoLancamento – dataEfetivacao – dataLancamento – categoriaId – codigoHistorico – historico – numeroDocumento – usuarioGerador – dataGeracao – usuarioAlteracao – dataAlteracao – podeTransferir properties: id: type: integer format: int64 description: extratoBancarioId: type: object allOf: – #/definitions/recExtratoBancario description: natureza: type: string allOf: – #/definitions/enumNatureza description: complementoLancamento: type: string description: dataEfetivacao: type: string format: date description: dataLancamento: type: string format: date description: valorLancamento: type: string description: categoriaId: type: integer format: int64 description: descricaoCategoria: type: string description: codigoHistorico: type: string description: historico: type: string description: numeroDocumento: type: string description: loteConciliacaoId: type: string description: saldo: type: string description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: podeTransferir: type: boolean description: recListaErros: description: type: object required: – retorno – bancoId – contaInternaId – arquivo properties: retorno: type: string description: Este campo será para controle, caso retorne OK (sem erros) e NOK (com erros) bancoId: type: string description: contaInternaId: type: integer format: int64 description: arquivo: type: string description: Nome do arquivo que foi importado recMovimentoContaInterna: description: type: object required: – id – empresaId – filial – contaInterna – dataMovimento – dataLiberacao – sequenciaMovimento – numeroDocumento – historico – valorMovimento – observacao – natureza – loteContabil – usuarioGerador – dataGeracao – usuarioAlteracao – dataAlteracao properties: id: type: integer format: int64 description: empresaId: type: object allOf: – #/definitions/recEmpresa description: filial: type: object allOf: – #/definitions/recFilial description: contaInterna: type: object allOf: – #/definitions/recContaInterna description: dataMovimento: type: string format: date description: dataLiberacao: type: string format: date description: dataConciliacao: type: string format: date description: sequenciaMovimento: type: integer format: int64 description: sequenciaPreparacao: type: string description: numeroDocumento: type: string description: historico: type: string description: numeroCheque: type: integer format: int64 description: valorMovimento: type: string description: valorMoeda: type: string description: observacao: type: string description: natureza: type: integer format: int64 description: chaveLote: type: string description: loteBaixa: type: integer format: int64 description: loteContabil: type: integer format: int64 description: loteConciliacaoId: type: string description: transacao: type: object allOf: – #/definitions/recTransacaoTesouraria description: naturezaGasto: type: object allOf: – #/definitions/recNaturezaGasto description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: saldoContaMovimento: type: string description: saldoAcumulado: type: string description: saldoAnterior: type: boolean description: disponivelConciliacao: type: boolean description: origem: type: string description: isMovimentoPreparacao: type: boolean description: recCategoriaExtrato: description: type: object required: – id – descricao properties: id: type: integer format: int64 description: descricao: type: string description: recPaginacao: description: type: object required: – pagina – numeroRegistrosPagina – listaOrdenacao properties: pagina: type: integer format: int64 description: numeroRegistrosPagina: type: integer format: int64 description: listaOrdenacao: type: array items: type: object allOf: – #/definitions/recListaOrdenacao minimum: 1 description: recListaOrdenacao: description: type: object required: – campo – ordenacao properties: campo: type: string description: ordenacao: type: string allOf: – #/definitions/enumTipoOrdenacao description: recMovimentoConciliado: description: type: object required: – id – empresaId – contaInterna – dataMovimento – sequenciaMovimento properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: contaInterna: type: string description: dataMovimento: type: string format: date description: sequenciaMovimento: type: integer format: int64 description: recExtratoConciliado: description: type: object required: – id – empresaId – contaInterna – dataEfetivacao – dataLancamento – sequenciaExtrato properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: contaInterna: type: string description: dataEfetivacao: type: string format: date description: dataLancamento: type: string format: date description: sequenciaExtrato: type: integer format: int64 description: statusDesconciliacao: description: type: object required: – lote – msg properties: lote: type: string description: msg: type: string description: recTransferencia: description: type: object required: – filialId – contaInternaId – valor properties: filialId: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: valor: type: string description: recMovTransferencia: description: type: object required: – id – movimentoContaInternaId – empresaId – contaInternaId – transacaoId – filialId – dataTransferencia – valor – natureza properties: id: type: integer format: int64 description: movimentoContaInternaId: type: integer format: int64 description: empresaId: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: transacaoId: type: integer format: int64 description: filialId: type: integer format: int64 description: dataTransferencia: type: string format: date description: valor: type: string description: natureza: type: string allOf: – #/definitions/enumNatureza description: recErpFinTesTesourariaMovimentoContaInterna: description: type: object required: – empresa – filial – contaInterna – dataMovimento – dataLiberacao – natureza – valor properties: id: type: integer format: int64 description: empresa: type: integer format: int64 description: filial: type: integer format: int64 description: contaInterna: type: string description: dataMovimento: type: string format: date description: sequenciaMovimento: type: integer format: int64 description: sequenciaPreparacao: type: string description: dataLiberacao: type: string format: date description: transacao: type: string description: naturezaGasto: type: integer format: int64 description: numeroDocumento: type: string description: historico: type: string description: numeroCheque: type: integer format: int64 description: observacao: type: string description: natureza: type: string allOf: – #/definitions/enumErpFinTesTesourariaNatureza description: situacao: type: string allOf: – #/definitions/enumErpFinTesTesourariaSituacao description: situacaoAnterior: type: string allOf: – #/definitions/enumErpFinTesTesourariaSituacao description: valor: type: string description: valorAnterior: type: string description: origemMovimento: type: string description: loteConciliacao: type: string description: tipoLancamento: type: string allOf: – #/definitions/enumTipoLancamento description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recErpFinTesTesourariaBanco: description: type: object required: – banco – descricao – abreviatura – segmento – cnpj properties: banco: type: string description: descricao: type: string description: abreviatura: type: string description: segmento: type: string description: cnpj: type: integer format: int64 description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recErpFinTesTesourariaAgencia: description: type: object required: – banco – agencia – abreviatura – descricao properties: banco: type: string description: agencia: type: string description: abreviatura: type: string description: descricao: type: string description: cep: type: integer format: int64 description: logradouro: type: string description: numero: type: string description: complemento: type: string description: bairro: type: string description: cidade: type: string description: estado: type: string description: telefone: type: string description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recErpFinTesTesourariaContaInterna: description: type: object required: – empresa – contaInterna – descricao – abreviatura properties: empresa: type: integer format: int64 description: contaInterna: type: string description: descricao: type: string description: abreviatura: type: string description: banco: type: string description: agencia: type: string description: tipoConta: type: string description: numeroContaBanco: type: string description: filial: type: array items: type: integer format: int64 description: moeda: type: string description: digitoVerificador: type: string description: limiteCredito: type: string description: dataAbertura: type: string format: date description: situacao: type: string allOf: – #/definitions/enumErpFinTesTesourariaSituacao description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string 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 entEmpresa: description: Empresas type: object required: – id – nome – fantasia – moedaId – usuarioGerador – dataGeracao – usuarioAlteracao – dataAlteracao properties: id: type: integer format: int64 description: nome: type: string description: fantasia: type: string description: moedaId: type: string description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entFilial: description: Filial type: object required: – id – empresaId – filial – nome – fantasia – cnpj – periodoInicial – periodoFinal properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: filial: type: integer format: int64 description: nome: type: string description: fantasia: type: string description: cnpj: type: integer format: int64 description: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entParametro: description: Parametros type: object properties: id: type: integer format: int64 description: descricao: type: string description: favorita: type: boolean description: json: type: string description: recParam: type: object allOf: – #/definitions/recParametros description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entBanco: description: Banco type: object required: – descricao – abreviatura – segmento – cnpj properties: id: type: string description: descricao: type: string description: abreviatura: type: string description: segmento: type: string description: cnpj: type: integer format: int64 description: logoMarca: type: string description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entAgencia: description: Agencia type: object required: – bancoId – agencia – abreviatura – descricao properties: id: type: integer format: int64 description: bancoId: type: string description: nomeBanco: type: string description: agencia: type: string description: abreviatura: type: string description: descricao: type: string description: cep: type: integer format: int64 description: logradouro: type: string description: numero: type: string description: complemento: type: string description: bairro: type: string description: cidade: type: string description: estado: type: string description: telefone: type: string description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entContaInterna: description: Conta Interna type: object required: – empresaId – numeroConta – descricao – abreviatura – tipoContaId properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: numeroConta: type: string description: descricao: type: string description: abreviatura: type: string description: bancoId: type: string description: agenciaId: type: integer format: int64 description: tipoContaId: type: string description: filialId: type: array items: type: integer format: int64 description: moedaId: type: string description: numeroContaBanco: type: string description: digitoVerificador: type: string description: limiteCredito: type: string description: dataAbertura: type: string format: date description: situacao: type: string description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entMovimentoContaInterna: description: Movimento Conta Interna type: object required: – empresaId – contaInternaId – dataMovimento – dataLiberacao – natureza – valor properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: dataMovimento: type: string format: date description: dataLiberacao: type: string format: date description: transacaoId: type: integer format: int64 description: naturezaGastoId: type: integer format: int64 description: numeroDocumento: type: string description: sequenciaMovimento: type: integer format: int64 description: historico: type: string description: numeroCheque: type: integer format: int64 description: observacao: type: string description: chaveLote: type: string description: loteContabil: type: integer format: int64 description: loteBaixa: type: integer format: int64 description: natureza: type: string allOf: – #/definitions/enumNatureza description: valor: type: string description: valorMoeda: type: string description: origemMovimento: type: string description: loteConciliacaoId: type: string description: movimentoExtratoOrigem: type: array items: type: integer format: int64 description: situacao: type: string allOf: – #/definitions/enumSituacao description: tipoLancamento: type: string description: sequenciaConciliacao: type: integer format: int64 description: origemConciliacao: type: string description: sequenciaPreparacao: type: string description: dataPrevisaoPagamento: type: string format: date description: dataConciliacao: type: string format: date description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: validarPeriodo: type: boolean description: entExtratoBancario: description: Extrato Bancário type: object required: – contaInternaId – descricao properties: id: type: integer format: int64 description: contaInternaId: type: integer format: int64 description: descricao: type: string description: loteServico: type: integer format: int64 description: dataInicioSaldo: type: string format: date description: saldoInicio: type: string description: dataFinalSaldo: type: string format: date description: saldoFinal: type: string description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entMovimentoExtratoBancario: description: Composição Extrato Bancário type: object required: – natureza – dataEfetivacao – dataLancamento properties: id: type: integer format: int64 description: extratoBancarioId: type: object allOf: – #/definitions/entExtratoBancario description: natureza: type: string allOf: – #/definitions/enumNatureza description: complementoLancamento: type: string description: dataEfetivacao: type: string format: date description: dataLancamento: type: string format: date description: valorLancamento: type: string description: categoriaId: type: integer format: int64 description: codigoHistorico: type: string description: sequencia: type: integer format: int64 description: historico: type: string description: numeroDocumento: type: string description: loteConciliacaoId: type: string description: contaInternaId: type: integer format: int64 description: identificacaoBancaria: type: string description: origemConciliacao: type: string description: dataConciliacao: type: string format: date description: sequenciaConciliacao: type: integer format: int64 description: origemExtrato: type: string allOf: – #/definitions/enumOrigemExtrato description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entSegmentoBanco: description: Segmento Bancário type: object required: – id – descricao properties: id: type: integer format: int64 description: descricao: type: string description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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