2.0info: 5.3.3 tcr_tituloreceber description: Serviço destinado a operações do contas a receber x-senior-domain: ERP FINANÇAS x-senior-domain-path: erp_fin x-senior-service-path: tcr_tituloreceber 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: /tcr_tituloreceber/queries/pesquisarEmpresa: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagina properties: texto: type: string description: pagina: type: object allOf: – #/definitions/recPagina description: responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/empresa minimum: 1 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/buscarIdsTodasEmpresas: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/buscarFiliaisMultiplasEmpresas: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – todas – pagina properties: texto: type: string description: todas: type: boolean description: somente: type: array items: type: integer format: int64 description: exceto: type: array items: type: integer format: int64 description: pagina: type: object allOf: – #/definitions/recPagina description: responses: 200: description: Ok schema: type: object required: – empresas properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresaComFiliais minimum: 1 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/buscarIdsFiliaisPorEmpresas: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaIds properties: empresaIds: type: array items: type: integer format: int64 minimum: 1 description: responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaIds description: in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object required: – filialIds properties: filialIds: type: array items: type: integer format: int64 minimum: 1 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/pesquisarFilial: post: description: SERVIÇO PARA COMPONENTE DE EMPRESA/FILIAL tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: texto: type: string description: empresaId: type: integer format: int64 description: pagina: type: object allOf: – #/definitions/recPagina description: responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterPropriedadesCamposTituloReceber: post: description: Retorna as propriedades de acesso dos campos de um título a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operacao – titulo properties: operacao: type: string allOf: – #/definitions/enumOperacao description: Tipo de operação titulo: type: object allOf: – #/definitions/entTituloReceber description: Dados do título a receber propriedadesAtuais: type: array items: type: object allOf: – #/definitions/recPropriedadesCampo description: Lista com as propriedades atuais camposAlterados: type: array items: type: string description: Ao informar os campos alterados, serão retornadas somente as atualizações de propriedades dos campos afetados pelos campos alterados responses: 200: description: Ok schema: type: object properties: propriedadesAlteradas: type: array items: type: object allOf: – #/definitions/recPropriedadesCampo description: Lista com as propriedades que foram modificadas em relação as propriedades atuais informadas (se informadas na entrada da query) default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterSituacaoTitulosAbertosCliente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataBase – pagina properties: empresaId: type: array items: type: integer format: int64 description: filialId: type: array items: type: integer format: int64 description: clienteId: type: array items: type: integer format: int64 description: tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: tiposTituloIds: type: array items: type: string description: vencimentoInicial: type: string format: date description: vencimentoFinal: type: string format: date description: modalidade: type: string allOf: – #/definitions/enumModalidadeTitulos description: dataBase: type: string format: date description: numeroTitulo: type: array items: type: string description: pagina: type: object allOf: – #/definitions/recPagina description: responses: 200: description: Ok schema: type: object required: – situacaoTitulosCliente – totalRegistros properties: situacaoTitulosCliente: type: array items: type: object allOf: – #/definitions/recSituacaoTitulosCliente minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterTitulosAbertosPorCliente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clienteId – dataBase – pagina properties: clienteId: type: integer format: int64 description: empresaId: type: array items: type: integer format: int64 description: filialId: type: array items: type: integer format: int64 description: tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: vencimentoInicial: type: string format: date description: vencimentoFinal: type: string format: date description: modalidade: type: string allOf: – #/definitions/enumModalidadeTitulos description: dataBase: type: string format: date description: numeroTitulo: type: array items: type: string description: pagina: type: object allOf: – #/definitions/recPagina description: responses: 200: description: Ok schema: type: object required: – totalRegistros properties: titulos: type: array items: type: object allOf: – #/definitions/recInformacoesResumidasTitulo description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterHistoricoCliente: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clienteId – filialId properties: clienteId: type: integer format: int64 description: filialId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – historicoCliente properties: historicoCliente: type: object allOf: – #/definitions/recHistoricoCliente description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: clienteId description: in: query required: true type: integer format: int64 – name: filialId description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – historicoCliente properties: historicoCliente: type: object allOf: – #/definitions/recHistoricoCliente description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterHistoricoRepresentante: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – representanteId – empresaId properties: representanteId: type: string description: empresaId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object properties: historicoRepresentante: type: object allOf: – #/definitions/recHistoricoRepresentante description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: representanteId description: in: query required: true type: string – name: empresaId description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: historicoRepresentante: type: object allOf: – #/definitions/recHistoricoRepresentante description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterClientes: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: termoBusca: type: string description: clienteId: type: integer format: int64 description: nome: type: string description: numeroDocumento: type: integer format: int64 description: pagina: type: object allOf: – #/definitions/recPagina description: situacao: type: string allOf: – #/definitions/enumSituacao description: responses: 200: description: Ok schema: type: object required: – totalRegistros properties: clientes: type: array items: type: object allOf: – #/definitions/recCliente description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterTamanhoMaximoPrefixoTitulo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – quantidadeTitulos properties: quantidadeTitulos: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – tamanhoMaximo properties: tamanhoMaximo: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: quantidadeTitulos description: in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tamanhoMaximo properties: tamanhoMaximo: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterSugestaoEntradaTitulos: post: description: Primitiva que irá sugerir os títulos para a sua geração em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – filialId – dataEmissao – dataEntrada – clienteId – tipoTituloId – transacaoEntradaId – prefixoTitulo – quantidadeTitulos – intervaloVencimento – primeiroVencimento – valor – tipoValorTitulo – manterDiaVencimento properties: empresaId: type: integer format: int64 description: Código da empresa do futuro título filialId: type: integer format: int64 description: Código da filial do futuro título dataEmissao: type: string format: date description: Data de emissão do futuro título dataEntrada: type: string format: date description: Data de entrada do futuro título clienteId: type: integer format: int64 description: Cliente do futuro título tipoTituloId: type: string description: Tipo de título do futuro título transacaoEntradaId: type: integer format: int64 description: Código da transação de entrada do futuro título prefixoTitulo: type: string maxLength: 15 description: Número sugestivo do futuro título quantidadeTitulos: type: integer format: int64 description: Quantidade de títulos a serem sugeridos intervaloVencimento: type: integer format: int64 description: Quantidade de dias entre um vencimento e outro primeiroVencimento: type: string format: date description: Data do primeiro vencimento do primeiro título valor: type: string description: Valor a serem gerados os futuros títulos tipoValorTitulo: type: string allOf: – #/definitions/enumTipoValorTitulo description: Tipo de geração do valor dos títulos manterDiaVencimento: type: boolean description: Vencimento sempre no mesmo dia responses: 200: description: Ok schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/entTituloReceber minimum: 1 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterQuantidadePosicoesPrefixoTitulo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – quantidadeTitulos properties: quantidadeTitulos: type: integer format: int64 description: Quantidade de títulos a serem gerados responses: 200: description: Ok schema: type: object required: – quantidadePosicoes properties: quantidadePosicoes: type: integer format: int64 description: Retorna a quantidade de posições para máscara do prefixo da numeração de títulos default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: quantidadeTitulos description: Quantidade de títulos a serem gerados in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – quantidadePosicoes properties: quantidadePosicoes: type: integer format: int64 description: Retorna a quantidade de posições para máscara do prefixo da numeração de títulos default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterTipoTitulos: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pagina: type: object allOf: – #/definitions/recPagina description: responses: 200: description: Ok schema: type: object required: – tipoTitulo – totalRegistros properties: tipoTitulo: type: array items: type: object allOf: – #/definitions/recTipoTitulo minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterTransacoesEntradaPorTipoTitulo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – tipoTituloId properties: empresaId: type: integer format: int64 description: tipoTituloId: type: string description: tipoMovimento: type: integer format: int64 description: Se informado, busca apenas transações com mesmo tipo de movimento moduloDiferenteDe: type: string description: Se informado, busca apenas transações com módulos diferentes pagina: type: object allOf: – #/definitions/recPagina description: responses: 200: description: Ok schema: type: object required: – transacoes – totalRegistros properties: transacoes: type: array items: type: object allOf: – #/definitions/entTransacaoContasReceber minimum: 1 description: totalRegistros: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/verificarVencimentoUtil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filialId – clienteId – vencimento properties: filialId: type: integer format: int64 description: clienteId: type: integer format: int64 description: vencimento: type: string format: date description: responses: 200: description: Ok schema: type: object required: – vencimento – vencimentoUtil properties: vencimento: type: string format: date description: vencimentoUtil: type: string format: date description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filialId description: in: query required: true type: integer format: int64 – name: clienteId description: in: query required: true type: integer format: int64 – name: vencimento description: in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – vencimento – vencimentoUtil properties: vencimento: type: string format: date description: vencimentoUtil: type: string format: date description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/retornarPrimeiroVencimento: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filialId – clienteId – dataEmissao properties: filialId: type: integer format: int64 description: clienteId: type: integer format: int64 description: dataEmissao: type: string format: date description: responses: 200: description: Ok schema: type: object required: – vencimentoUtil properties: vencimentoUtil: type: string format: date description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filialId description: in: query required: true type: integer format: int64 – name: clienteId description: in: query required: true type: integer format: int64 – name: dataEmissao description: in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – vencimentoUtil properties: vencimentoUtil: type: string format: date description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterSituacoesAlteracaoTitulo: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – situacao properties: situacao: type: array items: type: string allOf: – #/definitions/enumSituacaoTitulo minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – situacao properties: situacao: type: array items: type: string allOf: – #/definitions/enumSituacaoTitulo minimum: 1 description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterPortadores: post: description: Retorna os portadores de uma empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: array items: type: integer format: int64 minimum: 1 description: Ids das empresas id: type: array items: type: integer format: int64 description: Lista de ids dos postadores textoLivre: type: string description: Texto livre para pesquisar descrição ou código dos portadores codigoPortador: type: array items: type: string description: Lista de códigos dos portadores pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – portadores – totalRegistros properties: portadores: type: array items: type: object allOf: – #/definitions/recPortador minimum: 1 description: Lista de portadores encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterCarteiras: post: description: Retorna as carteiras de cobrança tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids das carteiras textoLivre: type: string description: Texto livre para pesquisar descrição ou id das carteiras pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – carteiras – totalRegistros properties: carteiras: type: array items: type: object allOf: – #/definitions/recCarteira minimum: 1 description: Lista de carteiras encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterMoedas: post: description: Retorna as moedas cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids das moedas textoLivre: type: string description: Texto livre para pesquisar descrição ou id das moedas sigla: type: array items: type: string description: Lista de siglas de moeda tipo: type: array items: type: string description: Lista de tipos de moeda pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – moedas – totalRegistros properties: moedas: type: array items: type: object allOf: – #/definitions/recMoeda minimum: 1 description: Lista de moedas encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterFormulasReajuste: post: description: Retorna as fórmulas de reajuste cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: array items: type: integer format: int64 minimum: 1 description: Ids das empresas id: type: array items: type: integer format: int64 description: Lista de ids das fórmulas de reajuste textoLivre: type: string description: Texto livre para pesquisar descrição ou código das fórmulas de reajuste codigoFormulaReajuste: type: array items: type: string description: Lista de códigos de fórmula de reajuste situacao: type: string allOf: – #/definitions/enumSituacao description: Situação da fórmula de reajuste pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – formulasReajuste – totalRegistros properties: formulasReajuste: type: array items: type: object allOf: – #/definitions/recFormulaReajuste minimum: 1 description: Lista de fórumlas de reajuste encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterRenegociacoes: post: description: Retorna as renegociações de crédito tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: array items: type: integer format: int64 minimum: 1 description: Ids das empresas id: type: array items: type: integer format: int64 description: Lista de ids das renegociações textoLivre: type: string description: Texto livre para pesquisar número ou o código da filial das renegociações filialId: type: array items: type: integer format: int64 description: Ids das filiais numeroRenegociacao: type: array items: type: integer format: int64 description: Lista de números de renegociação pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – renegociacoes – totalRegistros properties: renegociacoes: type: array items: type: object allOf: – #/definitions/recRenegociacao minimum: 1 description: Lista de renegociações encontradas totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterNaturezasDeGasto: post: description: Retorna as naturezas de gasto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: array items: type: integer format: int64 minimum: 1 description: Ids das empresas id: type: array items: type: integer format: int64 description: Lista de ids das naturezas de gasto textoLivre: type: string description: Texto livre para pesquisar descrição ou o código das naturezas de gasto codigoNatureza: type: array items: type: integer format: int64 description: Lista de códigos de natureza de gasto tipo: type: array items: type: string allOf: – #/definitions/enumTipoNaturezaGasto description: Tipo da natureza de gasto pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – naturezasDeGasto – totalRegistros properties: naturezasDeGasto: type: array items: type: object allOf: – #/definitions/recNaturezaGasto minimum: 1 description: Lista de naturezas de gasto encontradas totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterSacados: post: description: Retorna os sacados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids dos sacados textoLivre: type: string description: Texto livre para pesquisar nome ou o código dos sacados codigoSacado: type: array items: type: integer format: int64 description: Lista de códigos de sacado situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do sacado. Caso não informado irá retornar todos pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – sacados – totalRegistros properties: sacados: type: array items: type: object allOf: – #/definitions/recSacado minimum: 1 description: Lista de sacados encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterRepresentantes: post: description: Retorna os representantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids dos representantes textoLivre: type: string description: Texto livre para pesquisar nome ou o código dos representantes codigoRepresentante: type: array items: type: integer format: int64 description: Lista de códigos de representante filialId: type: integer format: int64 description: Código da filial do histórico do cliente clienteId: type: integer format: int64 description: Código do cliente pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – representantes – totalRegistros properties: representantes: type: array items: type: object allOf: – #/definitions/recRepresentante minimum: 1 description: Lista de representantes encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterFormasPagamento: post: description: Retorna as formas pagamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids das formas de pagamento textoLivre: type: string description: Texto livre para pesquisar numero ou descricao da forma de pagamento codigosFormaPagamento: type: array items: type: integer format: int64 description: Lista de códigos da forma de pagamento empresasId: type: array items: type: integer format: int64 description: Lista de códigos das empresas a serem procuradas a forma de pagamento situacao: type: string allOf: – #/definitions/enumSituacao description: Situação da forma de pagamento liberadaParaVenda: type: boolean description: Forma de pagamento liberada para venda? pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – formasPagamento – totalRegistros properties: formasPagamento: type: array items: type: object allOf: – #/definitions/recFormaPagamento minimum: 1 description: Lista de formas de pagamento encontrados totalRegistros: type: integer format: int64 description: Quantidade total de registros encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterMotivos: post: description: Retorna os motivos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids dos motivos textoLivre: type: string description: Texto livre para pesquisar os motivos pelo codigo ou pela descrição codigosMotivo: type: array items: type: string description: Lista de códigos dos motivos pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – motivos – totalRegistros properties: motivos: type: array items: type: object allOf: – #/definitions/recMotivo minimum: 1 description: Lista dos motivos encontrados totalRegistros: type: integer format: int64 description: Quantidade total de motivos encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterGrupoContas: post: description: Retorna os grupos de contas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Lista de ids dos grupo de contas textoLivre: type: string description: Texto livre para pesquisar os os grupo de contas pelo codigo e pela descricao codigosGrupoContas: type: array items: type: string description: Lista de códigos dos grupos de contas situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do grupo de contas tipoAplicacao: type: array items: type: string allOf: – #/definitions/enumTipoAplicacao description: Tipo de aplicacao pagina: type: object allOf: – #/definitions/recPagina description: Dados de paginação e ordenação responses: 200: description: Ok schema: type: object required: – grupoContas – totalRegistros properties: grupoContas: type: array items: type: object allOf: – #/definitions/recGrupoContas minimum: 1 description: Lista dos grupo de contas encontrados totalRegistros: type: integer format: int64 description: Quantidade total de grupo de contas encontrados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/queries/obterCotacaoEmissao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId – dataEmissao – moedaId properties: empresaId: type: integer format: int64 description: dataEmissao: type: string format: date description: moedaId: type: string description: responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: in: query required: true type: integer format: int64 – name: dataEmissao description: in: query required: true type: string format: date – name: moedaId description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – cotacao properties: cotacao: type: number format: double description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/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 /tcr_tituloreceber/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 /tcr_tituloreceber/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 /tcr_tituloreceber/actions/alterarTitulosReceber: post: description: Permite a alteração de títulos a receber em lotes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/entTituloReceber minimum: 1 description: Títulos a serem alterados responses: 200: description: Ok schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/entTituloReceber minimum: 1 description: Títulos alterados default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/excluirTitulosReceber: post: description: Permite a exclusão de títulos a receber em lotes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulos properties: titulos: type: array items: type: integer format: int64 minimum: 1 description: Id dos títulos a serem excluídos responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/alterarMovimentoBaixaReceber: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recMovimentoTituloReceber properties: fieldsChanges: type: array items: type: string description: recMovimentoTituloReceber: type: object allOf: – #/definitions/recMovimentoTituloReceber description: responses: 200: description: Ok schema: type: object required: – recMovimentoTituloReceber properties: recMovimentoTituloReceber: type: object allOf: – #/definitions/recMovimentoTituloReceber description: default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/gerarTitulosLote: post: description: Realiza a geração de títulos em lote tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/entTituloReceber minimum: 1 description: Lista de títulos a serem gerados responses: 200: description: Ok schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/entTituloReceber minimum: 1 description: Lista de títulos gerados com seus respectivos identificadores default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/baixarTituloPorPagamento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: array items: type: object allOf: – #/definitions/recBaixarTituloPagamento minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/baixarTituloPorAbatimento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: array items: type: object allOf: – #/definitions/recBaixarTitulo minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/baixarTituloPorDevolucao: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: array items: type: object allOf: – #/definitions/recBaixarTitulo minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/baixarTituloPorCancelamento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: array items: type: object allOf: – #/definitions/recBaixarTitulo minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/actions/baixarTituloPorLucrosPerdas: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: array items: type: object allOf: – #/definitions/recBaixarTitulo minimum: 1 description: responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/signals/executarSubstituicao: post: description: SAGA – Executar substituição no processo de baixa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idSaga properties: idSaga: type: string description: Identificador da SAGA fatosTitulosSubstitutos: type: array items: type: object allOf: – #/definitions/recFatoTitulosSubstitutos description: Fatos das substituições de títulos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/signals/compensarSubstituicao: post: description: SAGA – Executar a compensação da substituição tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idSaga properties: idSaga: type: string description: Identificador da SAGA idSubstitutos: type: array items: type: integer format: int64 description: Lista de títulos substitutos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entTituloReceber: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloReceber responses: 200: description: The created resource schema: #/definitions/entTituloReceber 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/entTituloReceber responses: 200: description: The created resource schema: #/definitions/entTituloReceber 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/entTituloReceber default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entTituloReceber/{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/entTituloReceber responses: 200: description: Ok schema: #/definitions/entTituloReceber 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/entTituloReceber responses: 200: description: Ok schema: #/definitions/entTituloReceber 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/entTituloReceber 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 /tcr_tituloreceber/entities/entTituloReceber/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entTituloReceber responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entNotaFiscal: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entNotaFiscal responses: 200: description: The created resource schema: #/definitions/entNotaFiscal 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/entNotaFiscal responses: 200: description: The created resource schema: #/definitions/entNotaFiscal 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/entNotaFiscal default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entNotaFiscal/{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/entNotaFiscal responses: 200: description: Ok schema: #/definitions/entNotaFiscal 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/entNotaFiscal responses: 200: description: Ok schema: #/definitions/entNotaFiscal 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/entNotaFiscal 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 /tcr_tituloreceber/entities/entNotaFiscal/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entNotaFiscal responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entFatura: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entFatura responses: 200: description: The created resource schema: #/definitions/entFatura 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/entFatura responses: 200: description: The created resource schema: #/definitions/entFatura 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/entFatura default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entFatura/{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/entFatura responses: 200: description: Ok schema: #/definitions/entFatura 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/entFatura responses: 200: description: Ok schema: #/definitions/entFatura 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/entFatura 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 /tcr_tituloreceber/entities/entFatura/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entFatura responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entTituloReceberMovimento: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloReceberMovimento responses: 200: description: The created resource schema: #/definitions/entTituloReceberMovimento 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/entTituloReceberMovimento responses: 200: description: The created resource schema: #/definitions/entTituloReceberMovimento 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/entTituloReceberMovimento default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entTituloReceberMovimento/{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/entTituloReceberMovimento responses: 200: description: Ok schema: #/definitions/entTituloReceberMovimento 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/entTituloReceberMovimento responses: 200: description: Ok schema: #/definitions/entTituloReceberMovimento 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/entTituloReceberMovimento 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 /tcr_tituloreceber/entities/entTituloReceberMovimento/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entTituloReceberMovimento responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/empresa: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/empresa responses: 200: description: The created resource schema: #/definitions/empresa 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/empresa responses: 200: description: The created resource schema: #/definitions/empresa 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/empresa default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/empresa/{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/empresa responses: 200: description: Ok schema: #/definitions/empresa 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/empresa responses: 200: description: Ok schema: #/definitions/empresa 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/empresa 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 /tcr_tituloreceber/entities/empresa/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/empresa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/filial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/filial responses: 200: description: The created resource schema: #/definitions/filial 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/filial responses: 200: description: The created resource schema: #/definitions/filial 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/filial default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/filial/{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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial 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 /tcr_tituloreceber/entities/filial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filial responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entTransacaoContasReceber: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTransacaoContasReceber responses: 200: description: The created resource schema: #/definitions/entTransacaoContasReceber 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/entTransacaoContasReceber responses: 200: description: The created resource schema: #/definitions/entTransacaoContasReceber 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/entTransacaoContasReceber default: description: Error response schema: #/definitions/genericError /tcr_tituloreceber/entities/entTransacaoContasReceber/{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/entTransacaoContasReceber responses: 200: description: Ok schema: #/definitions/entTransacaoContasReceber 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/entTransacaoContasReceber responses: 200: description: Ok schema: #/definitions/entTransacaoContasReceber 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/entTransacaoContasReceber 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 /tcr_tituloreceber/entities/entTransacaoContasReceber/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entTransacaoContasReceber responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumTipoVencimento: description: type: string enum: – ProvavelPagamento – VencimentoProrrogado enumModalidadeTitulos: description: Enumeração para filtros type: string enum: – Previstos – Efetivos – Ambos enumModalidadeTitulo: description: Enumeração para retorno de dados type: string enum: – Previsto – Efetivo enumTipoValorTitulo: description: type: string enum: – Igualitario – Dividido enumTipoAplicacao: description: Define o tipo de aplicacao do grupo de contas type: string enum: – Ambos – ContasReceber – ContasPagar enumTipoNaturezaGasto: description: Define o tipo de natureza de gasto type: string enum: – Normal – Recebimento – Transferencia enumOrigemComissao: description: type: string enum: – CLIENTE – REPRESENTANTE enumTipoJuros: description: type: string enum: – Simples – Composto enumPeriodoCalculoDesconto: description: type: string enum: – Diario – Semanal – Quinzenal – Mensal – Trimestral – Semestral – Anual enumOrigemTitulo: description: type: string enum: – ContasAReceber – NotaFiscalVenda – EmissaoFatura enumTipoOrdenacao: description: Enumeração para o tipo de ordenação type: string enum: – Asc – Desc enumSituacaoTitulo: description: Situações de um título a receber type: string enum: – ABERTO_ORGAO_PROTECAO_CREDITO – ABERTO_NEGOCIACAO – ABERTO_ADVOGADO – ABERTO_NORMAL – ABERTO_CARTORIO – ABERTO_ENCONTRO_CONTAS – ABERTO_IMPOSTOS – ABERTO_RETORNO_JURIDICO – ABERTO_PROTESTADO – ABERTO_REPRESENTANTE – ABERTO_SUSPENSO – ABERTO_GESTAO_PESSOAS – ABERTO_EXTERNO – ABERTO_CE – ABERTO_COBRANCA – ABERTO_PE – CANCELADO – TEMPORARIO – LIQUIDADO_NORMAL – LIQUIDADO_CARTORIO – LIQUIDADO_IMPOSTOS – LIQUIDADO_COMPENSADO – LIQUIDADO_COBRANCA – LIQUIDADO_PROTESTADO – LIQUIDADO_SUBSTITUIDO – LIQUIDADO_GESTAO_PESSOAS – LIQUIDADO_EXTERNO enumSituacao: description: Situação de regtistro type: string enum: – Ativo – Inativo enumOperacao: description: Tipo de operação em registro type: string enum: – INCLUSAO – ALTERACAO – EXCLUSAO 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 recTesouraria: description: type: object required: – contaInternaId – transacaoId properties: contaInternaId: type: integer format: int64 description: transacaoId: type: integer format: int64 description: documento: type: string description: recBaixarTituloPagamento: description: type: object required: – tituloId – transacaoBaixaId – tesouraria – valoresBaixa properties: tituloId: type: integer format: int64 description: transacaoBaixaId: type: integer format: int64 description: tesouraria: type: object allOf: – #/definitions/recTesouraria description: valoresBaixa: type: object allOf: – #/definitions/recValoresBaixa description: recBaixarTitulo: description: type: object required: – tituloId – transacaoBaixaId – valoresBaixa properties: tituloId: type: integer format: int64 description: transacaoBaixaId: type: integer format: int64 description: valoresBaixa: type: object allOf: – #/definitions/recValoresBaixa description: recValoresBaixa: description: type: object required: – valorMovimento properties: valorMovimento: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorDescontos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: recInformacoesResumidasTitulo: description: type: object required: – id – empresaId – filialId – numeroTitulo – tipoTitulo – cliente – transacaoEntradaId – dataEntrada – dataEmissao – vencimentoOriginal – vencimentoProrrogado – vencimentoProvavelPagamento – vencido – diasEmAtraso – valores – portadorId – carteiraId – moedaId – situacaoTitulo properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: numeroTitulo: type: string description: tipoTitulo: type: object allOf: – #/definitions/recTipoTitulo description: cliente: type: object allOf: – #/definitions/recCliente description: transacaoEntradaId: type: integer format: int64 description: dataEntrada: type: string format: date description: dataEmissao: type: string format: date description: vencimentoOriginal: type: string format: date description: vencimentoProrrogado: type: string format: date description: vencimentoProvavelPagamento: type: string format: date description: vencido: type: boolean description: diasEmAtraso: type: integer format: int64 description: notaFiscal: type: object allOf: – #/definitions/recNotaFiscal description: fatura: type: object allOf: – #/definitions/recFatura description: valores: type: object allOf: – #/definitions/recValoresTitulo description: valoresMemoria: type: object allOf: – #/definitions/recValoresMemoria description: Memória de cálculo dos valores outrosNegociados: type: string description: descontosNegociados: type: string description: jurosDia: type: string description: dataDesconto: type: string format: date description: percentualDesconto: type: number format: double description: percentualMulta: type: number format: double description: portadorId: type: integer format: int64 description: carteiraId: type: string description: moedaId: type: string description: codigoBarras: type: string description: dataAlteracao: type: string format: date-time description: modalidadeTitulo: type: string allOf: – #/definitions/enumModalidadeTitulo description: situacaoTitulo: type: object allOf: – #/definitions/recSituacaoTitulo description: recValoresMemoria: description: type: object required: – memoriaJuros – memoriaMulta – memoriaOutrosAcrescimos – memoriaDescontos – memoriaCorrecao – memoriaOutrosDescontos – memoriaReajusteAcrescimos – memoriaReajusteOutrosDescontos – memoriaValorLiquido properties: memoriaJuros: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de juros memoriaMulta: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de multa memoriaOutrosAcrescimos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de outros acrescimos memoriaDescontos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de descontos memoriaCorrecao: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de correção monetária memoriaOutrosDescontos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de outros descontos memoriaReajusteAcrescimos: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de reajuste de acréscimos memoriaReajusteOutrosDescontos: type: object allOf: – #/definitions/recMemoria description: memória do cálculo de reajuste de outros descontos memoriaValorLiquido: type: object allOf: – #/definitions/recMemoria description: Memória do cálculo de valor líquido recValoresTitulo: description: type: object required: – valorOriginal – valorAberto – valorJuros – valorMulta – valorEncargos – valorCorrecao – valorOutrosAcrescimos – valorDescontos – valorOutrosDescontos – valorLiquido properties: valorOriginal: type: string description: valorAberto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorDescontos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: recMemoria: description: Memória de cálculo type: object required: – memoriaCalculoFormula – memoriaCalculoFormulaTraduzida properties: memoriaCalculoFormula: type: array items: type: string minimum: 1 description: Formula do cáluco com as variávies memoriaCalculoFormulaTraduzida: type: array items: type: string minimum: 1 description: Formula do cálculo com os valores recTipoTitulo: description: type: object required: – id – descricao properties: id: type: string description: descricao: type: string description: recMovimentoTituloReceber: description: type: object properties: id: type: integer format: int64 description: tituloReceberId: type: integer format: int64 description: portadorId: type: integer format: int64 description: carteiraId: type: string description: transacaoContasReceberId: type: integer format: int64 description: sequenciaMovimento: type: integer format: int64 description: dataMovimento: type: string format: date description: valorAberto: type: string description: observacao: type: string description: vencimentoProrrogado: type: string format: date description: dataPagamento: type: string format: date description: cotacao: type: string description: valorMovimento: type: string description: valorDesconto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: dataUltimoPagamento: type: string format: date description: dataUltimoJuros: type: string format: date description: numeroLoteContabil: type: integer format: int64 description: valorCorrecaoMonetaria: type: string description: percentualJuros: type: string description: diasJuros: type: integer format: int64 description: valorCotacao: type: string description: valorCotacaoFormulaReajuste: type: string description: isConsiderarOutrosAcrescimos: type: boolean description: isConsiderarOutrosDescontos: type: boolean description: movimentoContaInternaId: type: integer format: int64 description: usuarioGeracao: type: string description: Usuário de cadastro dataGeracao: type: string format: date-time description: Data de cadastro usuarioAlteracao: type: string description: Usuário de alteração dataAlteracao: type: string format: date-time description: Data de alteração recNotaFiscal: description: type: object properties: id: type: integer format: int64 description: numero: type: integer format: int64 description: serie: type: string description: filialId: type: integer format: int64 description: recFatura: description: type: object properties: id: type: integer format: int64 description: numero: type: integer format: int64 description: filialId: type: integer format: int64 description: recAuditoria: description: type: object required: – dataGeracao – usuarioGeracao – dataAlteracao – usuarioAlteracao properties: dataGeracao: type: string format: date-time description: usuarioGeracao: type: string description: dataAlteracao: type: string format: date-time description: usuarioAlteracao: type: string description: recSituacaoTitulosCliente: description: type: object required: – cliente – quantidadeTitulos – totalValorAberto – totalValorOriginal properties: cliente: type: object allOf: – #/definitions/recCliente description: quantidadeTitulos: type: integer format: int64 description: totalValorAberto: type: string description: totalValorOriginal: type: string description: totalValorLiquido: type: string description: recCliente: description: type: object required: – id – nome – numeroDocumento properties: id: type: integer format: int64 description: nome: type: string description: numeroDocumento: type: integer format: int64 description: numeroDocumentoFormatado: type: string description: telefone: type: string description: recHistoricoCliente: description: type: object required: – clienteId – filialId – carteiraId – periodoCalculoDesconto properties: clienteId: type: integer format: int64 description: filialId: type: integer format: int64 description: criterioVencimento: type: string maxLength: 1 description: formulaReajusteId: type: integer format: int64 description: calcularDesconto: type: string maxLength: 1 description: percentualDesconto: type: number format: double description: descontoPontualidade: type: number format: double description: representanteId: type: string description: Id UUID percentualMulta: type: number format: double description: toleranciaDiasMulta: type: integer format: int64 description: percentualJuros: type: number format: double description: tipoJuros: type: string allOf: – #/definitions/enumTipoJuros description: toleranciaDiasJuros: type: integer format: int64 description: carteiraId: type: string maxLength: 3 description: formaPagamentoId: type: string description: Id UUID periodoCalculoDesconto: type: string allOf: – #/definitions/enumPeriodoCalculoDesconto description: origemPercentualComissao: type: string allOf: – #/definitions/enumOrigemComissao description: percentualComissao: type: number format: double description: quantidadeDiasVencimento: type: integer format: int64 description: recHistoricoRepresentante: description: type: object required: – representanteId – empresaId properties: representanteId: type: string description: empresaId: type: integer format: int64 description: percentualComissao: type: number format: double description: percentualRecebimento: type: number format: double description: representanteSuperiorId: type: string description: percentualRepresentanteSuperior: type: number format: double description: recSituacaoTitulo: description: type: object required: – situacaoTitulo – sigla – descricao properties: situacaoTitulo: type: string allOf: – #/definitions/enumSituacaoTitulo description: sigla: type: string description: descricao: type: string description: recPagina: description: type: object required: – offset – limit properties: offset: type: integer format: int64 description: limit: type: integer format: int64 description: listaOrdenacao: type: array items: type: object allOf: – #/definitions/recListaOrdenacao description: Campos da ordenação dos registros a serem pesquisados recEmpresaComFiliais: description: type: object required: – id – codigo – nome – filiais properties: id: type: integer format: int64 description: codigo: type: string description: nome: type: string description: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: recFilial: description: type: object required: – id – nome – codigo properties: id: type: integer format: int64 description: nome: type: string description: codigo: type: string description: recListaOrdenacao: description: Define o registro com os dados dos campos à serem ordenados type: object required: – campo – ordenacao properties: campo: type: string description: Nome do campo a ser ordenado ordenacao: type: string allOf: – #/definitions/enumTipoOrdenacao description: Tipo de ordenação do campo (ASC / DESC) recPortador: description: Dados do portador type: object required: – id – empresaId – portador – descricao properties: id: type: integer format: int64 description: Id do portador empresaId: type: integer format: int64 description: Id da empresa do portador portador: type: string description: Código do portador descricao: type: string description: Descrição do portador recCarteira: description: Dados da carteira de cobrança type: object required: – id – descricao properties: id: type: string description: Id da carteira descricao: type: string description: Descrição da carteira recMoeda: description: Dados da moeda type: object required: – id – descricao – sigla properties: id: type: string description: Id da moeda descricao: type: string description: Descrição da moeda sigla: type: string description: Sigla da moeda tipo: type: string description: Tipo da moeda recFormulaReajuste: description: Dados da fórmula de reajuste type: object required: – id – empresaId – codigo – descricao – situacao properties: id: type: integer format: int64 description: Id da fórmula de reajuste empresaId: type: integer format: int64 description: Id da empresa da fórmula de reajuste codigo: type: string description: Código da fórmula de reajuste descricao: type: string description: Descrição da fórmula de reajuste situacao: type: string allOf: – #/definitions/enumSituacao description: Situação da fórmula de reajuste recRenegociacao: description: Dados da renegociação type: object required: – id – empresaId – filialId – numeroRenegociacao – dataGeracao properties: id: type: integer format: int64 description: Id da renegociação empresaId: type: integer format: int64 description: Id da empresa da renegociação filialId: type: integer format: int64 description: Id da filial da renegociação numeroRenegociacao: type: integer format: int64 description: Número da renegociação dataGeracao: type: string format: date description: Data de geração da renegociação recNaturezaGasto: description: Dados da natureza de gasto type: object required: – id – empresaId – codigoNatureza properties: id: type: integer format: int64 description: Id da natureza de gasto empresaId: type: integer format: int64 description: Id da empresa da natureza de gasto codigoNatureza: type: integer format: int64 description: Código da natureza de gasto descricaoNatureza: type: string description: Descrição da natureza de gasto recSacado: description: Dados do sacado type: object required: – id – codigoSacado – nome – situacao properties: id: type: string description: Id do sacado (UUID) codigoSacado: type: integer format: int64 description: Código do sacado nome: type: string description: Nome do sacado fantasia: type: string description: Nome fantasia do sacado situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do sacado recRepresentante: description: Dados do representante type: object required: – id – codigoRepresentante – nome properties: id: type: string description: Id do representante (UUID) codigoRepresentante: type: integer format: int64 description: Código do representante nome: type: string description: Nome do representante fantasia: type: string description: Nome fantasia do representante recFormaPagamento: description: Dados da forma de pagamento type: object required: – id – codigo – empresaId properties: id: type: string description: Id da forma de pagamento (UUID) codigo: type: integer format: int64 description: Código da forma de pagamento empresaId: type: integer format: int64 description: Empresa da forma de pagamento descricao: type: string description: Descrição da forma de pagamento isLiberada: type: boolean description: Define se uma forma de pagamento está liberada ou não para qualquer cliente situacao: type: string allOf: – #/definitions/enumSituacao description: Situação da forma de pagamento recMotivo: description: Dados do motivo type: object required: – id – codigo properties: id: type: string description: Id do motivo(UUID) codigo: type: string description: Código do motivo descricao: type: string description: Descrição do motivo recGrupoContas: description: Dados do grupo de contas type: object required: – id – codigo properties: id: type: string description: Id do grupo de contas(UUID) codigo: type: string description: Código do grupo de contas descricao: type: string description: Descrição do grupo de contas tipoAplicacao: type: object allOf: – #/definitions/recTipoAplicacao description: Tipo de aplicação do grupo de contas recTipoAplicacao: description: Dados do tipo de aplicação do grupo de contas type: object required: – tipoAplicacao – descricao properties: tipoAplicacao: type: string allOf: – #/definitions/enumTipoAplicacao description: Tipo de aplicação descricao: type: string description: Descrição recTituloInconsistente: description: Inconsistências encontradas na validação dos título type: object required: – id – empresaId – filialId – numeroTitulo – tipoTituloId – mensagensInconsistencias properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: numeroTitulo: type: string description: tipoTituloId: type: string description: mensagensInconsistencias: type: array items: type: string minimum: 1 description: recPropriedadesCampo: description: Propriedades de acesso de um campo type: object required: – nome – somenteLeitura – obrigatorio – afetaPropriedadesOutrosCampos properties: nome: type: string description: Nome do campo somenteLeitura: type: boolean description: Campo somente leitura? obrigatorio: type: boolean description: Campo obrigatório? afetaPropriedadesOutrosCampos: type: boolean description: Alteração do campo afeta propriedades de outros campos? recFatoTitulosSubstitutos: description: SAGA – Registro de fatos da substituição de títulos type: object required: – chave – titulosSubstituto properties: chave: type: string description: Identificador titulosSubstituto: type: object allOf: – #/definitions/recTituloSubstituto description: Títulos substitutos recTituloSubstituto: description: SAGA – Registro de títulos substituto type: object required: – tituloSubstitutoId – filialId – clienteId – tipoTituloId – numeroTitulo – transacaoEntradaId – moedaId – dataEntrada – dataEmissao – formaPagamentoId – valorOriginal – vencimentoOriginal – vencimentoProrrogado – provavelPagamento – chequeBanco – chequeAgencia – chequeContaCorrente – chequeNumero – sequenciaLigacaoBaixa – saldoSobra – fatoFinanceiroId properties: tituloSubstitutoId: type: string description: Identificador de títulos substituto filialId: type: integer format: int64 description: Identificador da filial clienteId: type: integer format: int64 description: Identificador de cliente tipoTituloId: type: integer format: int64 description: Identificador de tipo de título numeroTitulo: type: string description: Número de título transacaoEntradaId: type: integer format: int64 description: Identificador de transação de entrada moedaId: type: string description: Identificador de Moeda dataEntrada: type: string format: date description: Data de entrada dataEmissao: type: string format: date description: Data de emissão formaPagamentoId: type: string description: Identificador de forma de pagamento valorOriginal: type: string description: Valor original vencimentoOriginal: type: string format: date description: Vencimento original vencimentoProrrogado: type: string format: date description: Vencimento prorrogado provavelPagamento: type: string format: date description: Data provável pagamento chequeBanco: type: string description: Banco do cheque chequeAgencia: type: string description: Agência do cheque chequeContaCorrente: type: string description: Conta interna do cheque chequeNumero: type: string description: Número do cheque sequenciaLigacaoBaixa: type: integer format: int64 description: Sequência da ligação de baixa saldoSobra: type: string description: Saldo da sobra fatoFinanceiroId: type: string description: Identificador do fato financeiro 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 entTituloReceber: description: type: object required: – empresaId – filialId – clienteId – tipoTituloId – moedaId – portadorId – carteiraId – transacaoContasReceberId – numero – dataEntrada – dataEmissao – valorOriginal – vencimentoOriginal – origemTitulo – representanteId properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: clienteId: type: integer format: int64 description: tipoTituloId: type: string description: moedaId: type: string description: portadorId: type: integer format: int64 description: portadorIdAnterior: type: integer format: int64 description: carteiraId: type: string description: carteiraAnteriorId: type: string description: transacaoContasReceberId: type: integer format: int64 description: numero: type: string description: dataEntrada: type: string format: date description: dataEmissao: type: string format: date description: valorOriginal: type: string description: valorAberto: type: string description: vencimentoOriginal: type: string format: date description: vencimentoProrrogado: type: string format: date description: provavelPagamento: type: string format: date description: numeroFilial: type: integer format: int64 description: situacaoTitulo: type: string allOf: – #/definitions/enumSituacaoTitulo description: situacaoTituloAnterior: type: string description: origemTitulo: type: string allOf: – #/definitions/enumOrigemTitulo description: notaFiscal: type: object allOf: – #/definitions/entNotaFiscal description: fatura: type: object allOf: – #/definitions/entFatura description: dataNegociados: type: string format: date description: jurosNegociados: type: string description: multaNegociados: type: string description: descontosNegociados: type: string description: outrosNegociados: type: string description: observacao: type: string description: cotacaoNegociada: type: string description: calcularAntecipacaoDesconto: type: boolean description: toleranciaDiasDesconto: type: integer format: int64 description: dataDesconto: type: string format: date description: valorDesconto: type: string description: percentualDesconto: type: string description: tipoPeriodoDesconto: type: string allOf: – #/definitions/enumPeriodoCalculoDesconto description: percentualMulta: type: string description: toleranciaDiasMulta: type: integer format: int64 description: prorrogaJuros: type: boolean description: dataCalculoJuros: type: string format: date description: percentualJuros: type: string description: tipoJuros: type: string allOf: – #/definitions/enumTipoJuros description: jurosDia: type: string description: toleranciaDiasJuros: type: integer format: int64 description: naturezaGastoId: type: integer format: int64 description: sacadoId: type: string description: representanteId: type: string description: formaPagamentoId: type: string description: motivoId: type: string description: grupoContasId: type: string description: percentualComissao: type: string description: percentualComissaoRecebimento: type: string description: valorBaseComissao: type: string description: valorComissao: type: string description: cotacaoEmissao: type: string description: formulaReajusteId: type: integer format: int64 description: cotacaoMoedaReajuste: type: string description: codigoBarras: type: string description: cobNossoNumero: type: string description: auditoria: type: object allOf: – #/definitions/recAuditoria description: entNotaFiscal: description: type: object required: – numero – serie properties: id: type: integer format: int64 description: numero: type: integer format: int64 description: serie: type: string description: filialId: type: integer format: int64 description: entFatura: description: type: object required: – numero properties: id: type: integer format: int64 description: numero: type: integer format: int64 description: filialId: type: integer format: int64 description: entTituloReceberMovimento: description: type: object required: – tituloReceberId – portadorId – carteiraId – valorAberto – valorMovimento – valorLiquido properties: id: type: integer format: int64 description: tituloReceberId: type: integer format: int64 description: portadorId: type: integer format: int64 description: carteiraId: type: string description: transacaoContasReceberId: type: integer format: int64 description: sequenciaMovimento: type: integer format: int64 description: dataMovimento: type: string format: date description: valorAberto: type: string description: observacao: type: string description: vencimentoProrrogado: type: string format: date description: dataPagamento: type: string format: date description: cotacao: type: string description: valorMovimento: type: string description: valorDesconto: type: string description: valorJuros: type: string description: valorMulta: type: string description: valorEncargos: type: string description: valorCorrecao: type: string description: valorOutrosAcrescimos: type: string description: valorOutrosDescontos: type: string description: valorLiquido: type: string description: dataUltimoPagamento: type: string format: date description: dataUltimoJuros: type: string format: date description: numeroLoteContabil: type: integer format: int64 description: valorCorrecaoMonetaria: type: string description: percentualJuros: type: string description: diasJuros: type: integer format: int64 description: valorCotacao: type: string description: valorCotacaoFormulaReajuste: type: string description: isConsiderarOutrosAcrescimos: type: boolean description: isConsiderarOutrosDescontos: type: boolean description: movimentoContaInternaId: type: integer format: int64 description: usuarioGeracao: type: string description: Usuário de cadastro dataGeracao: type: string format: date-time description: Data de cadastro usuarioAlteracao: type: string description: Usuário de alteração dataAlteracao: type: string format: date-time description: Data de alteração empresa: description: type: object required: – codigo – nome properties: id: type: integer format: int64 description: codigo: type: string maxLength: 4 description: nome: type: string maxLength: 100 description: filial: description: type: object required: – id – nome – codigo properties: id: type: integer format: int64 description: nome: type: string description: codigo: type: string description: entTransacaoContasReceber: description: type: object required: – empresaId – transacao – descricao – modulo – tipoMovimento – tipoBaixa – aceitaManual – situacao properties: id: type: integer format: int64 description: empresaId: type: integer format: int64 description: transacao: type: string maxLength: 5 description: descricao: type: string description: modulo: type: string maxLength: 3 description: tipoMovimento: type: integer format: int64 description: tipoBaixa: type: string description: aceitaManual: type: boolean description: naturezaGastoId: type: integer format: int64 description: situacao: type: string allOf: – #/definitions/enumSituacao 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. discriminator: _discriminator type: object required: – _discriminator properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. _discriminator: type: string description: 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