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

dda_debitodiretoautorizado

188 views 0 22/10/2018 Atualizado em 30/09/2024 integrador

2.0info: 10.14.2 dda_debitodiretoautorizado description: Serviço destinado a vinculação de código de barras com títulos do contas a pagar, onde é necessário utilizar arquivos bancários gerados por Débito Direto Autorizado x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: dda_debitodiretoautorizado contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /dda_debitodiretoautorizado/queries/temIntegracaoG5: post: description: Verifica se o tenant está configurado para integrar com a G5 tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – temIntegracao properties: temIntegracao: type: boolean description: Indicador se possui ou não integração com G5 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o tenant está configurado para integrar com a G5 tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – temIntegracao properties: temIntegracao: type: boolean description: Indicador se possui ou não integração com G5 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/buscaTitulosAcimaVencimentoFinalPendencias: post: description: Inclui na busca títulos acima do vencimento final da pendência tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – incluiTitulos properties: incluiTitulos: type: boolean description: Indica se deve ou não incluir os títulos acima do vencimento na busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Inclui na busca títulos acima do vencimento final da pendência tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – incluiTitulos properties: incluiTitulos: type: boolean description: Indica se deve ou não incluir os títulos acima do vencimento na busca 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterFornecedores: post: description: Retorna uma listagem de fornecedores a partir de um termo. Essa busca irá pesquisar por:\nCódigo\nCPF / CNPJ.\nNome\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Situações de associação da pendência filtrarPendenciaInativa: type: boolean description: Quando true trará somente as pendências inativas default: false responses: 200: description: Ok schema: type: object required: – fornecedores properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor minimum: 1 description: Listagem dos fornecedores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/verificarSituacaoImportacao: post: description: Verifica a situação da importação do arquivo de formato CNAB240. Como a importação é assyncrona, essa primitiva\nretorna a situação da importação. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – logImportacaoId properties: logImportacaoId: type: integer format: int64 description: Código do log da importação responses: 200: description: Ok schema: type: object required: – situacao – banco – erro properties: situacao: type: string allOf: – #/definitions/situacaoImportacao description: Situação da importação banco: type: object allOf: – #/definitions/recBanco description: Estrutura do banco encontrato pelo arquivo importado erro: type: string description: Log de erro caso ocorreram inconsistências na importação relatorio: type: string format: byte description: Relatório dos erros encontrados em formato base64 (.pdf) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica a situação da importação do arquivo de formato CNAB240. Como a importação é assyncrona, essa primitiva\nretorna a situação da importação. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: logImportacaoId description: Código do log da importação in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – situacao – banco – erro properties: situacao: type: string allOf: – #/definitions/situacaoImportacao description: Situação da importação banco: type: object allOf: – #/definitions/recBanco description: Estrutura do banco encontrato pelo arquivo importado erro: type: string description: Log de erro caso ocorreram inconsistências na importação relatorio: type: string format: byte description: Relatório dos erros encontrados em formato base64 (.pdf) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterEmpresas: post: description: Retorna a listagem de empresas cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Paginação da listagem quantidade: type: integer format: int64 description: Quantidade de registros a serem retornados responses: 200: description: Ok schema: type: object required: – empresas – totalRegistros properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Estrutura das empresas encontradas totalRegistros: type: integer format: int64 description: Total de empresas retornadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a listagem de empresas cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Paginação da listagem in: query type: integer format: int64 – name: quantidade description: Quantidade de registros a serem retornados in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – empresas – totalRegistros properties: empresas: type: array items: type: object allOf: – #/definitions/recEmpresa minimum: 1 description: Estrutura das empresas encontradas totalRegistros: type: integer format: int64 description: Total de empresas retornadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterFiliais: post: description: Retorna a listagem de filiais cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresasId: type: array items: type: integer format: int64 description: Filtrar filiais por empresas offset: type: integer format: int64 description: Paginação da listagem quantidade: type: integer format: int64 description: Quantidade de registros a serem retornados responses: 200: description: Ok schema: type: object required: – filiais – totalRegistros properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Estrutura das empresas encontradas totalRegistros: type: integer format: int64 description: Total de filiais encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a listagem de filiais cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresasId description: Filtrar filiais por empresas in: query type: array items: type: integer format: int64 – name: offset description: Paginação da listagem in: query type: integer format: int64 – name: quantidade description: Quantidade de registros a serem retornados in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – filiais – totalRegistros properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Estrutura das empresas encontradas totalRegistros: type: integer format: int64 description: Total de filiais encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterBancosPendencias: post: description: Retorna os bancos que tenham pendências de associação com títulos a pagar tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: bancosId: type: array items: type: string description: Listagem dos bancos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os bancos que tenham pendências de associação com títulos a pagar tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: bancosId: type: array items: type: string description: Listagem dos bancos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterNomeArquivosPendencias: post: description: Retorna o nome dos arquivos por fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filialId: type: array items: type: integer format: int64 description: Lista de filiais cpfCnpjFornecedor: type: array items: type: integer format: int64 description: CPF ou CNPG dos fornecedores periodoInicial: type: string format: date description: Período inicial da pesquisa, com base na data de vencimento da pendência periodoFinal: type: string format: date description: Período final da pesquisa, com base na data de vencimento da pendência tiposPendencia: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Tipos de pendência situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Situações de associação da pendência tiposAssociacao: type: array items: type: object allOf: – #/definitions/recTipoAssociacao description: Tipos de associação da pendência filtrarPendenciaInativa: type: boolean description: Quando true trará somente as pendências inativas default: false responses: 200: description: Ok schema: type: object properties: nomeArquivos: type: array items: type: string description: Listagem dos bancos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterFornecedoresParametrizacao: post: description: Retorna os fornecedores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vencimentoInicial – vencimentoFinal properties: empresaId: type: array items: type: integer format: int64 description: Lista de empresas filialId: type: array items: type: integer format: int64 description: Lista de filiais vencimentoInicial: type: string format: date description: Vencimento inicial vencimentoFinal: type: string format: date description: Vencimento final responses: 200: description: Ok schema: type: object required: – fornecedores properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor minimum: 1 description: Listagem dos fornecedores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os fornecedores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: Lista de empresas in: query type: array items: type: integer format: int64 – name: filialId description: Lista de filiais in: query type: array items: type: integer format: int64 – name: vencimentoInicial description: Vencimento inicial in: query required: true type: string format: date – name: vencimentoFinal description: Vencimento final in: query required: true type: string format: date responses: 200: description: Ok schema: type: object required: – fornecedores properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor minimum: 1 description: Listagem dos fornecedores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/verificarSituacaoAssociacao: post: description: Verifica a situação do processo de associação da pendência com o título a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação responses: 200: description: Ok schema: type: object required: – situacao properties: situacao: type: string allOf: – #/definitions/enumSituacaoProcessoAssociacao description: Situação do processo de associação log: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica a situação do processo de associação da pendência com o título a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processoId description: Código do processo de associação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – situacao properties: situacao: type: string allOf: – #/definitions/enumSituacaoProcessoAssociacao description: Situação do processo de associação log: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterPendenciasAssociadasProcessoAssociacao: post: description: Resultado do processo automático de associação de pendências com títulos a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação offset: type: integer format: int64 description: Último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada paginacao: type: object allOf: – #/definitions/recPaginacao description: paginacao de entrada responses: 200: description: Ok schema: type: object properties: titulosAssociados: type: array items: type: object allOf: – #/definitions/recTituloAssociado description: Listagem dos títulos associados com as pendências totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterFornecedoresPendentesProcessoAssociacao: post: description: Resultado dos fornecedores do processo automático de associação de pendências com títulos a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação tiposPendencia: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Tipos dos movimentos de remessa offset: type: integer format: int64 description: Último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: fornecedoresPendentes: type: array items: type: object allOf: – #/definitions/recFornecedor description: Listagem dos fornecedores onde há pendências que não foram associadas com nenhum título a pagar,\nsendo necessário realizar a associação manualmente totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/buscarPendenciasFornecedor: post: description: Listagem das pendências por fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação cpfCnpjFornecedor: type: integer format: int64 description: CPF / CNPJ do fornecedor periodoInicial: type: string format: date description: Período inicial para filtragem das pendências periodoFinal: type: string format: date description: Período final para filtragem das pendências tipoPendencias: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Filtro por tipo de pendência offset: type: integer format: int64 description: Último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada responses: 200: description: Ok schema: type: object properties: pendencias: type: array items: type: object allOf: – #/definitions/recPendencia description: Listagem das pendências encontradas totalRegistros: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/buscarTitulosFornecedor: post: description: Listagem de títulos a pagar por fornecedor e/ou pela raiz de CNPJ do fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fornecedorId properties: fornecedorId: type: integer format: int64 description: Código do fornecedor periodoInicial: type: string format: date description: Período inicial para filtragem dos títulos a pagar periodoFinal: type: string format: date description: Período final para filtragem dos títulos a pagar buscarPorRaizCNPJ: type: boolean description: Indicativo se é para buscar títulos a pagar pela raiz de CNPJ do fornecedor responses: 200: description: Ok schema: type: object properties: titulosPagar: type: array items: type: object allOf: – #/definitions/recTituloPagar description: Listagem dos títulos a pagar encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listagem de títulos a pagar por fornecedor e/ou pela raiz de CNPJ do fornecedor tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fornecedorId description: Código do fornecedor in: query required: true type: integer format: int64 – name: periodoInicial description: Período inicial para filtragem dos títulos a pagar in: query type: string format: date – name: periodoFinal description: Período final para filtragem dos títulos a pagar in: query type: string format: date – name: buscarPorRaizCNPJ description: Indicativo se é para buscar títulos a pagar pela raiz de CNPJ do fornecedor in: query type: boolean responses: 200: description: Ok schema: type: object properties: titulosPagar: type: array items: type: object allOf: – #/definitions/recTituloPagar description: Listagem dos títulos a pagar encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/buscarTitulosPendencia: post: description: Realiza a busca de titulos que estão associados com a pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendenciaId properties: pendenciaId: type: integer format: int64 description: Código da pendência responses: 200: description: Ok schema: type: object properties: titulosPagar: type: array items: type: object allOf: – #/definitions/recTituloPagar description: Listagem dos títulos a pagar que estão associados com a pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a busca de titulos que estão associados com a pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pendenciaId description: Código da pendência in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: titulosPagar: type: array items: type: object allOf: – #/definitions/recTituloPagar description: Listagem dos títulos a pagar que estão associados com a pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/buscarTitulosPendentes: post: description: Realiza uma nova busca de títulos para possível vínculo com a pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processoId – pendenciaId – tipoBusca properties: processoId: type: string description: Código do processo pendenciaId: type: integer format: int64 description: Código da pendência para vinculo manual tipoBusca: type: string allOf: – #/definitions/enumTipoBusca description: Tipo de busca para encontrar títulos a pagar responses: 200: description: Ok schema: type: object properties: titulosPagar: type: array items: type: object allOf: – #/definitions/recTituloPagar description: Listagem dos títulos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterTiposPendencia: post: description: Retorna a listagem dos possíveis tipos de pendências tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tipoPendencias properties: tipoPendencias: type: array items: type: object allOf: – #/definitions/recTipoPendencia minimum: 1 description: Estrutra dos tipos de pedências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a listagem dos possíveis tipos de pendências tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tipoPendencias properties: tipoPendencias: type: array items: type: object allOf: – #/definitions/recTipoPendencia minimum: 1 description: Estrutra dos tipos de pedências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterUltimosDdasImportados: post: description: Retorna a listagem dos últimos arquivos de formato CNAB240 importados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: logs: type: array items: type: object allOf: – #/definitions/recLog description: Listagem dos útlimos arquivos importados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a listagem dos últimos arquivos de formato CNAB240 importados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: logs: type: array items: type: object allOf: – #/definitions/recLog description: Listagem dos útlimos arquivos importados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterParametrizacaoFilial: post: description: Retorna a parametrização para associação automática por filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filialId properties: filialId: type: integer format: int64 description: Código da filial parametrizada responses: 200: description: Ok schema: type: object properties: parametrizacao: type: object allOf: – #/definitions/recParametrizacaoFilial description: Retorna os parâmetros cadastrados da filial. Caso não há cadastro, será retornado os valores padrões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a parametrização para associação automática por filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: filialId description: Código da filial parametrizada in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: parametrizacao: type: object allOf: – #/definitions/recParametrizacaoFilial description: Retorna os parâmetros cadastrados da filial. Caso não há cadastro, será retornado os valores padrões 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterPendenciasAssociadas: post: description: Resultado do processo automático de associação de pendências com títulos a pagar, utilizando filtros tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filiaisId: type: array items: type: integer format: int64 description: Códigos das filiais fornecedoresId: type: array items: type: integer format: int64 description: Códigos dos fornecedores cpfCnpjFornecedores: type: array items: type: integer format: int64 description: CNPJ/CPF dos fornecedores periodoInicial: type: string format: date description: Período inicial da pesquisa, com base na data de vencimento da pendência periodoFinal: type: string format: date description: Período final da pesquisa, com base na data de vencimento da pendência nomeArquivo: type: array items: type: string description: Nome do arquivo tiposPendencia: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Tipos de pendência situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Situações de associação da pendência tiposAssociacao: type: array items: type: object allOf: – #/definitions/recTipoAssociacao description: Tipos de associação da pendência offset: type: integer format: int64 description: Último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada paginacao: type: object allOf: – #/definitions/recPaginacao description: paginacao de entrada responses: 200: description: Ok schema: type: object properties: titulosAssociados: type: array items: type: object allOf: – #/definitions/recTituloAssociado description: Listagem dos títulos associados com as pendências totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterSituacoesAssociacao: post: description: Retorna as enumerações de situação de associação contendo a enumeração e sua descrição tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – situacoesAssociacao properties: situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia minimum: 1 description: Situações de associação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as enumerações de situação de associação contendo a enumeração e sua descrição tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – situacoesAssociacao properties: situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia minimum: 1 description: Situações de associação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterTiposAssociacao: post: description: Retorna as enumerações de tipos de associação contendo a enumeração e sua descrição tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tiposAssociacao properties: tiposAssociacao: type: array items: type: object allOf: – #/definitions/recTipoAssociacao minimum: 1 description: Tipos de associação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as enumerações de tipos de associação contendo a enumeração e sua descrição tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – tiposAssociacao properties: tiposAssociacao: type: array items: type: object allOf: – #/definitions/recTipoAssociacao minimum: 1 description: Tipos de associação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterPortadores: post: description: Retorna os portadores cadastrados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresasId: type: array items: type: integer format: int64 description: Filtro das empresas do portador responses: 200: description: Ok schema: type: object required: – portadores properties: portadores: type: array items: type: object allOf: – #/definitions/recPortador minimum: 1 description: Lista dos portadores cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os portadores cadastrados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresasId description: Filtro das empresas do portador in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – portadores properties: portadores: type: array items: type: object allOf: – #/definitions/recPortador minimum: 1 description: Lista dos portadores cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterCarteiras: post: description: Retorna as carteiras cadastradas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – carteiras properties: carteiras: type: array items: type: object allOf: – #/definitions/recCarteira minimum: 1 description: Lista das carteiras cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as carteiras cadastradas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – carteiras properties: carteiras: type: array items: type: object allOf: – #/definitions/recCarteira minimum: 1 description: Lista das carteiras cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterTransacoesPrevistas: post: description: Retorna todas as transacoes previstas (onde o modulo é CPP) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresasId: type: array items: type: integer format: int64 description: Filtro das empresas da transação responses: 200: description: Ok schema: type: object required: – transacoesPrevistas properties: transacoesPrevistas: type: array items: type: object allOf: – #/definitions/recTransacaoContasPagar minimum: 1 description: Lista das transações previstas cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as transacoes previstas (onde o modulo é CPP) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresasId description: Filtro das empresas da transação in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – transacoesPrevistas properties: transacoesPrevistas: type: array items: type: object allOf: – #/definitions/recTransacaoContasPagar minimum: 1 description: Lista das transações previstas cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterTransacoesBaixaCancelamento: post: description: Retorna todas as transacoes de baixa (onde o modulo é CPB e a baixa é CA) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresasId: type: array items: type: integer format: int64 description: Filtro das empresas da transação responses: 200: description: Ok schema: type: object required: – transacoesBaixa properties: transacoesBaixa: type: array items: type: object allOf: – #/definitions/recTransacaoContasPagar minimum: 1 description: Lista das transações previstas cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as transacoes de baixa (onde o modulo é CPB e a baixa é CA) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresasId description: Filtro das empresas da transação in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – transacoesBaixa properties: transacoesBaixa: type: array items: type: object allOf: – #/definitions/recTransacaoContasPagar minimum: 1 description: Lista das transações previstas cadastradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterPendencias: post: description: Filtrar pendências tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pendenciasId: type: array items: type: integer format: int64 description: Filtrar pelos identificadores das pendências empresasId: type: array items: type: integer format: int64 description: Filtro por código de empresa filiaisId: type: array items: type: integer format: int64 description: Filtro por código de filial cpfCnpjFornecedores: type: array items: type: integer format: int64 description: Filtro por código de fornecedor periodoInicial: type: string format: date description: Período inicial da pesquisa, com base na data de vencimento da pendência periodoFinal: type: string format: date description: Período final da pesquisa, com base na data de vencimento da pendência nomeArquivo: type: array items: type: string description: Nome do arquivo tiposPendencia: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Filtro por tipos de pendência situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Filtro por situações de associação da pendência offset: type: integer format: int64 description: Último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada paginacao: type: object allOf: – #/definitions/recPaginacao description: paginacao de entrada filtrarPendenciaInativa: type: boolean description: Quando true trará somente as pendências inativas default: false responses: 200: description: Ok schema: type: object properties: pendencias: type: array items: type: object allOf: – #/definitions/recPendencia description: Pendências do DDA totalRegistros: type: integer format: int64 description: Quantidade total de registros da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterSituacaoIntegracaoPendencia: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – associacao properties: associacao: type: array items: type: object allOf: – #/definitions/recAssociacaoPendencia minimum: 1 description: responses: 200: description: Ok schema: type: object properties: situacoesIntegracao: type: array items: type: object allOf: – #/definitions/recSituacaoIntegracao description: Situação de integração da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterParametrosFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: quantidade: type: integer format: int64 description: responses: 200: description: Ok schema: type: object required: – totalRegistros properties: parametrosFilial: type: array items: type: object allOf: – #/definitions/entParametrosFilial description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: in: query type: integer format: int64 – name: quantidade description: in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalRegistros properties: parametrosFilial: type: array items: type: object allOf: – #/definitions/entParametrosFilial description: totalRegistros: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterExportacao: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – exportacaoId properties: exportacaoId: type: integer format: int64 description: Código do processo de exportacao responses: 200: description: Ok schema: type: object required: – situacao – download properties: situacao: type: string allOf: – #/definitions/enumSituacaoProcessoAssociacao description: Situação do processo de associação download: type: string format: byte description: Arquivo logErro: type: string description: log de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: exportacaoId description: Código do processo de exportacao in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – situacao – download properties: situacao: type: string allOf: – #/definitions/enumSituacaoProcessoAssociacao description: Situação do processo de associação download: type: string format: byte description: Arquivo logErro: type: string description: log de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterHistoricoMovimetacaoPendencias: post: description: Retornar o histórico de movimentações de uma pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendenciaId properties: pendenciaId: type: integer format: int64 description: ID da pendência responses: 200: description: Ok schema: type: object required: – historicoMovimentacao – dataGeracao – usuario properties: historicoMovimentacao: type: array items: type: object allOf: – #/definitions/recHistoricoMovimentacao minimum: 1 description: Histório da movimentação dataGeracao: type: string format: date-time description: Data de geração da pendência usuario: type: string description: Usuário de geração da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar o histórico de movimentações de uma pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pendenciaId description: ID da pendência in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – historicoMovimentacao – dataGeracao – usuario properties: historicoMovimentacao: type: array items: type: object allOf: – #/definitions/recHistoricoMovimentacao minimum: 1 description: Histório da movimentação dataGeracao: type: string format: date-time description: Data de geração da pendência usuario: type: string description: Usuário de geração da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterValoresCodigoBarras: post: description: Explode o código de barras e retorna qual é o banco, valor e vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoBarras properties: codigoBarras: type: string description: Linha digitável do código de barras responses: 200: description: Ok schema: type: object required: – valores properties: valores: type: object allOf: – #/definitions/recCodigoBarras description: Retorna o banco, valor e o vencimento do código de barras 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Explode o código de barras e retorna qual é o banco, valor e vencimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codigoBarras description: Linha digitável do código de barras in: query required: true type: string responses: 200: description: Ok schema: type: object required: – valores properties: valores: type: object allOf: – #/definitions/recCodigoBarras description: Retorna o banco, valor e o vencimento do código de barras 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterBancos: post: description: Retorna os bancos cadastrados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: bancos: type: array items: type: object allOf: – #/definitions/recBanco description: Bancos retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os bancos cadastrados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: bancos: type: array items: type: object allOf: – #/definitions/recBanco description: Bancos retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/obterFornecedoresCadastrados: post: description: Retornar os fornecedores cadastrados, independente de pendências cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Paginação da listagem quantidade: type: integer format: int64 description: Quantidade de registros a serem retornados fornecedorId: type: array items: type: integer format: int64 description: Filtrar por fornecedor filtro: type: string description: Permitir pesquisar por nome/cnpj/cpf responses: 200: description: Ok schema: type: object required: – totalRegistros properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor description: Fornecedores encontrados totalRegistros: type: integer format: int64 description: Total de fornecedores retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar os fornecedores cadastrados, independente de pendências cadastradas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Paginação da listagem in: query type: integer format: int64 – name: quantidade description: Quantidade de registros a serem retornados in: query type: integer format: int64 – name: fornecedorId description: Filtrar por fornecedor in: query type: array items: type: integer format: int64 – name: filtro description: Permitir pesquisar por nome/cnpj/cpf in: query type: string responses: 200: description: Ok schema: type: object required: – totalRegistros properties: fornecedores: type: array items: type: object allOf: – #/definitions/recFornecedor description: Fornecedores encontrados totalRegistros: type: integer format: int64 description: Total de fornecedores retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/importarCNAB240: post: description: Incluir arquivos de formato CNAB240 do padrão FEBRABAN. Essa inclusão somente será dos segmentos G e H do arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arquivo properties: arquivo: type: object allOf: – #/definitions/recArquivo description: Estrutra do arquivo a ser importado responses: 200: description: Ok schema: type: object required: – logImportacaoId properties: logImportacaoId: type: integer format: int64 description: Código de log da importação que foi iniciada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/processarPendenciasAssociacao: post: description: Iniciar o processamento de associação das pendências com os títulos a pagar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: bancoId: type: integer format: int64 description: Banco para processamento de associação periodoInicial: type: string format: date description: Período inicial para filtragem das pendências periodoFinal: type: string format: date description: Período final para filtragem das pendências filiaisId: type: array items: type: integer format: int64 description: Filtro de filiais para processamento das pendências cpfCnpjFornecedores: type: array items: type: integer format: int64 description: CPF/CNPJ ou fornecedores filtrarAcimaDoRange: type: boolean description: Quando true pesquisará por títulos acima do vencimento informado, caso não ache na busca normal default: false responses: 200: description: Ok schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/gerarAssociacaoLote: post: description: Realiza a busca de títulos a pagar que tenham as mesmas características da pendência importada por lote.\nAo encontrar títulos semelhantes, é realizado a ligação da pendência com um ou mais títulos. Nesse processamento,\ntambém poderão ser utilizadas regras de tolerância que foram cadastradas por filial. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação pendencias: type: array items: type: object allOf: – #/definitions/recPendencia description: Lista de pendências do lote filiaisId: type: array items: type: integer format: int64 description: Lista de filiais do lote filtrarAcimaDoRange: type: boolean description: Quando true pesquisará por títulos acima do vencimento informado, caso não ache na busca normal default: false responses: 200: description: Ok schema: type: object required: – situacao – processoId properties: situacao: type: string allOf: – #/definitions/enumSituacaoProcessoAssociacao description: Situação do processo de associação do lote de fornecedores processoId: type: string description: processo id da associação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/associarTituloPendencia: post: description: Associar manualmente uma pendência com um título a pagar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processoId – pendenciaId – tituloPagarId – dataAlteracaoPendencia – dataAlteracaoTituloPagar properties: processoId: type: string description: Código do processo de associação pendenciaId: type: integer format: int64 description: Código da pendência tituloPagarId: type: integer format: int64 description: Código do título a pagar dataAlteracaoPendencia: type: string format: date-time description: Úlitma data de alteração da pendência dataAlteracaoTituloPagar: type: string format: date-time description: Úlitma data de alteração do título à pagar responses: 200: description: Ok schema: type: object properties: tituloAssociado: type: object allOf: – #/definitions/recTituloAssociado description: Estrutura da associação da pendência com o título a pagar log: type: string description: Log de associação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/desassociarTituloPendencia: post: description: Realizar a desassociação da pendência com o título a pagar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – associacaoPendencia properties: associacaoPendencia: type: array items: type: object allOf: – #/definitions/recAssociacaoPendencia minimum: 1 description: Listagem das associações já realizadas isGerarEvento: type: boolean description: Habilita ou desabilita a geração de evento. Por padrão irá gerar. responses: 200: description: Ok schema: type: object required: – logs properties: logs: type: array items: type: object allOf: – #/definitions/recLogCancelamento minimum: 1 description: Retorno da desassociação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/excluirAssociacoesTituloPagar: post: description: Exclui um título a pagar desassociando as pendências existentes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tituloPagarIds properties: tituloPagarIds: type: array items: type: integer format: int64 minimum: 1 description: Listagem do id dos títulos a excluir responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/efetivarTituloAssociado: post: description: Alterar a situação da associação da pendência com o título a pagar de Aguardando Confirmação para Efetivado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – associacaoPendencia properties: associacaoPendencia: type: array items: type: object allOf: – #/definitions/recAssociacaoPendencia minimum: 1 description: Estrutura da associação da pendência com o título a pagar responses: 200: description: Ok schema: type: object properties: logs: type: array items: type: string description: Retorna um log do processamento de efetivacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/cancelarAssociacaoPendencia: post: description: Cancela uma associação de uma pendeencia que está efetivada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendencias properties: pendencias: type: array items: type: object allOf: – #/definitions/recIdentificadorPendencia minimum: 1 description: Registro das pendências responses: 200: description: Ok schema: type: object properties: logs: type: array items: type: object allOf: – #/definitions/recLogCancelamento description: Retorna um log do processamento de cancelamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/excluirPendencia: post: description: Metódo que exclui as pendências tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: pendencias: type: array items: type: object allOf: – #/definitions/recIdentificadorPendencia description: Identificador da pendência a ser excluída filtrarPendenciaInativa: type: boolean description: Quando true trará somente as pendências inativas default: false responses: 200: description: Ok schema: type: object properties: logs: type: array items: type: object allOf: – #/definitions/recLogCancelamento description: Log de consistência por pendência caso ocorra alguma consistência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/excluirParametrizacao: post: description: Método que exclui uma parametrização tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametrizacaoId properties: parametrizacaoId: type: integer format: int64 description: Identificador da parametrização responses: 200: description: Ok schema: type: object required: – dummy properties: dummy: type: string description: Retorno da exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/exportarPendencias: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoExportacao properties: empresasId: type: array items: type: integer format: int64 description: Filtro por código de empresa filiaisId: type: array items: type: integer format: int64 description: Filtro por código de filial cpfCnpjFornecedores: type: array items: type: integer format: int64 description: Filtro por código de fornecedor periodoInicial: type: string format: date description: Período inicial da pesquisa, com base na data de vencimento da pendência periodoFinal: type: string format: date description: Período final da pesquisa, com base na data de vencimento da pendência tiposPendencia: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Filtro por tipos de pendência situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Filtro por situações de associação da pendência tipoExportacao: type: string allOf: – #/definitions/enumTipoExportacao description: Tipo de exportação offset: type: integer format: int64 description: Último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada nomeArquivo: type: array items: type: object allOf: – #/definitions/recNomeArquivo description: Nomes dos arquivos a serem filtrados responses: 200: description: Ok schema: type: object required: – exportacaoId properties: exportacaoId: type: integer format: int64 description: Código do processo de exportacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/exportarPendenciasAssociadas: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipoExportacao properties: filiaisId: type: array items: type: integer format: int64 description: Códigos das filiais fornecedoresId: type: array items: type: integer format: int64 description: Códigos dos fornecedores cpfCnpjFornecedores: type: array items: type: integer format: int64 description: CNPJ/CPF dos fornecedores periodoInicial: type: string format: date description: Período inicial da pesquisa, com base na data de vencimento da pendência periodoFinal: type: string format: date description: Período final da pesquisa, com base na data de vencimento da pendência tiposPendencia: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Tipos de pendência situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Situações de associação da pendência tiposAssociacao: type: array items: type: object allOf: – #/definitions/recTipoAssociacao description: Tipos de associação da pendência tipoExportacao: type: string allOf: – #/definitions/enumTipoExportacao description: Tipo de exportação offset: type: integer format: int64 description: Último item mostrado quantidade: type: integer format: int64 description: Quantidade de itens a ser retornada nomeArquivo: type: array items: type: object allOf: – #/definitions/recNomeArquivo description: Nomes dos arquivos a serem filtrados responses: 200: description: Ok schema: type: object required: – exportacaoId properties: exportacaoId: type: integer format: int64 description: Código do processo de exportacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/validarFiliaisProcessamento: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresaId: type: array items: type: integer format: int64 description: filialId: type: array items: type: integer format: int64 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/salvarPendencia: post: description: Ação para salvar uma pendência de forma manual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendencia properties: pendencia: type: object allOf: – #/definitions/recPendenciaManual description: Informações da pendência manual responses: 200: description: Ok schema: type: object required: – pendenciaId properties: pendenciaId: type: integer format: int64 description: Identificador da pendência manual gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/actions/atualizarPendencia: post: description: Ação para atualizar uma pendência de forma manual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendencia properties: pendencia: type: object allOf: – #/definitions/recPendenciaManual description: Informações da pendência manual responses: 200: description: Ok schema: type: object required: – pendenciaId properties: pendenciaId: type: integer format: int64 description: Identificador da pendência manual gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/importarCNAB240Automaticamente: post: description: Faz a importação de arquivo CNAB240 automaticamente (esta primitiva será chamada pelo agendado) tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/gerarAssociacaoPendenciaTituloEmLote: post: description: Realiza a busca de títulos a pagar que tenham as mesmas características da pendência importada por lote.\nAo encontrar títulos semelhantes, é realizado a ligação da pendência com um ou mais títulos. Nesse processamento,\ntambém poderão ser utilizadas regras de tolerância que foram cadastradas por filial. Este signal tem a mesma\nfunção da action gerarAssociacaoLote mas, por ser um signal, não há risco de timeout. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação pendencias: type: array items: type: object allOf: – #/definitions/recPendencia description: Lista de pendências do lote filiaisId: type: array items: type: integer format: int64 description: Lista de filiais do lote filtrarAcimaDoRange: type: boolean description: Quando true pesquisará por títulos acima do vencimento informado, caso não ache na busca normal default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/excluirPendencias: post: description: Método que exclui todas as pendências segundo o filtro, independente da paginação. tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: empresasId: type: array items: type: integer format: int64 description: Filtro por código de empresa filiaisId: type: array items: type: integer format: int64 description: Filtro por código de filial cpfCnpjFornecedores: type: array items: type: integer format: int64 description: Filtro por código de fornecedor periodoInicial: type: string format: date description: Período inicial da pesquisa, com base na data de vencimento da pendência periodoFinal: type: string format: date description: Período final da pesquisa, com base na data de vencimento da pendência nomeArquivo: type: array items: type: string description: Nome do arquivo tiposPendencia: type: array items: type: object allOf: – #/definitions/recTipoPendencia description: Filtro por tipos de pendência situacoesAssociacao: type: array items: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Filtro por situações de associação da pendência filtrarPendenciaInativa: type: boolean description: Quando true trará somente as pendências inativas default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/excluirPendenciaAutomatica: post: description: Exclui as pendências do tipo 2 – pedido de baixa, apenas com a situação ERRO tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/notificarPendenciasVencimento: post: description: Notifica na plataforma uma mensagem informando aos usuários do DDA quais pendências estão vencendo e irão vencer no próximo dia útil tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/recriarSaldosContasInternas: post: description: Recria toda a tabela de saldos novamente a partir das movimentações tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/startProcessoAssociacaoPendencia: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/tryFinalizaProcessoAssociacaoSucesso: post: description: Finaliza processo associação com sucesso tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/tryFinalizaProcessoAssociacaoErro: post: description: Finaliza processo associação com erro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId – erro properties: processoId: type: string description: Código do processo de associação erro: type: string description: Mensagem de erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/criaAssociacaoPendenciaTask: post: description: Cria associação entre pendências e processo de associação da tarefa em execução tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId properties: taskId: type: string description: Identificador da Task pendenciasId: type: array items: type: integer format: int64 description: Identificadores das pendências responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/processaTaskAssociacao: post: description: Evento responsável por iniciar o processamento da tarefa de forma paralelizada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId – nomeWorker – workers – ultimoWorkId properties: taskId: type: string description: Identificador da Task nomeWorker: type: string description: Nome do worker workers: type: integer format: int64 description: Número de workers ultimoWorkId: type: string description: Identificador do último work alocado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/tarefaAssociacaoFinalizada: post: description: Evento que sinaliza a finalização do processamento da tarefa tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – taskId – situacao properties: taskId: type: string description: Identificador da Task situacao: type: string description: Situação da Task responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/gerarAssociacaoPendenciaTituloEmLoteV2: post: description: Versão 2 – Realiza a busca de títulos a pagar que tenham as mesmas características da pendência importada por lote.\nAo encontrar títulos semelhantes, é realizado a ligação da pendência com um ou mais títulos. Nesse processamento,\ntambém poderão ser utilizadas regras de tolerância que foram cadastradas por filial. Este signal é a versão 2 do\nsignal gerarAssociacaoPendenciaTituloEmLote que foi criado para paralelizar o processamento dos processos de\nassociação em tarefas com menos pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Identificador do Processo de Associação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/finalizaProcessoAssociacao: post: description: Signal para finalização do processo de associção de pendências e títulos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId properties: processoId: type: string description: Código do processo de associação responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/signals/limparDadosProcessoAssociacao: post: description: Signal chamado para remover dados antigos de processos de associação tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/processoAssociacaoFinalizado: post: description: Evento que identifica quando um processo é finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – idProcesso properties: idProcesso: type: string description: Identificador do processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/incluidoTituloPagarDDA: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – recTituloPagar properties: recTituloPagar: type: object allOf: – #/definitions/recTituloPagarG5 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/alteradoTituloPagarDDA: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – recTituloPagar properties: recTituloPagar: type: object allOf: – #/definitions/recTituloPagarG5 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/excluidoTituloPagarDDA: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – recTituloPagar properties: recTituloPagar: type: object allOf: – #/definitions/recTituloPagarG5 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/tituloPagarBaixadoDDA: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – empresaId – filialId – fornecedorId – tipoTituloId – numeroTitulo – dataBaixa – transacaoBaixaId – valorBaixa – valorLiquido properties: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: fornecedorId: type: integer format: int64 description: tipoTituloId: type: string description: numeroTitulo: type: string description: dataBaixa: type: string format: date description: transacaoBaixaId: type: integer format: int64 description: valorBaixa: 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: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/tituloPagarBaixaEstornadaDDA: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – empresaId – filialId – fornecedorId – tipoTituloId – numeroTitulo – sequenciaMovimento properties: empresaId: type: integer format: int64 description: filialId: type: integer format: int64 description: fornecedorId: type: integer format: int64 description: tipoTituloId: type: string description: numeroTitulo: type: string description: sequenciaMovimento: type: integer format: int64 description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/inseridoBanco: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – banco properties: banco: type: object allOf: – #/definitions/recErpFinTesTesourariaBanco description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/alteradoBanco: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – banco properties: banco: type: object allOf: – #/definitions/recErpFinTesTesourariaBanco description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/excluidoBanco: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – banco properties: banco: type: object allOf: – #/definitions/recErpFinTesTesourariaBanco description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/inseridoAgencia: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agencia properties: agencia: type: object allOf: – #/definitions/recErpFinTesTesourariaAgencia description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/alteradoAgencia: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agencia properties: agencia: type: object allOf: – #/definitions/recErpFinTesTesourariaAgencia description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/excluidoAgencia: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – agencia properties: agencia: type: object allOf: – #/definitions/recErpFinTesTesourariaAgencia description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/inseridoContaInterna: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – contaInterna properties: contaInterna: type: object allOf: – #/definitions/recErpFinTesTesourariaContaInterna description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/alteradoContaInterna: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – contaInterna properties: contaInterna: type: object allOf: – #/definitions/recErpFinTesTesourariaContaInterna description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/events/excluidoContaInterna: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – contaInterna properties: contaInterna: type: object allOf: – #/definitions/recErpFinTesTesourariaContaInterna description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entEspecieTipoTitulo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entEspecieTipoTitulo responses: 200: description: The created resource schema: #/definitions/entEspecieTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entEspecieTipoTitulo responses: 200: description: The created resource schema: #/definitions/entEspecieTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/entEspecieTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entEspecieTipoTitulo/{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/entEspecieTipoTitulo responses: 200: description: Ok schema: #/definitions/entEspecieTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entEspecieTipoTitulo responses: 200: description: Ok schema: #/definitions/entEspecieTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entEspecieTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entEspecieTipoTitulo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entEspecieTipoTitulo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entTipoTitulo: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTipoTitulo responses: 200: description: The created resource schema: #/definitions/entTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTipoTitulo responses: 200: description: The created resource schema: #/definitions/entTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/entTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entTipoTitulo/{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/entTipoTitulo responses: 200: description: Ok schema: #/definitions/entTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTipoTitulo responses: 200: description: Ok schema: #/definitions/entTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entTipoTitulo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entTipoTitulo/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entTipoTitulo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entFornecedor: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entFornecedor responses: 200: description: The created resource schema: #/definitions/entFornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entFornecedor responses: 200: description: The created resource schema: #/definitions/entFornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/entFornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entFornecedor/{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/entFornecedor responses: 200: description: Ok schema: #/definitions/entFornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entFornecedor responses: 200: description: Ok schema: #/definitions/entFornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entFornecedor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entFornecedor/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entFornecedor responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entTituloPagar: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloPagar responses: 200: description: The created resource schema: #/definitions/entTituloPagar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entTituloPagar responses: 200: description: The created resource schema: #/definitions/entTituloPagar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/entTituloPagar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entTituloPagar/{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/entTituloPagar responses: 200: description: Ok schema: #/definitions/entTituloPagar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entTituloPagar responses: 200: description: Ok schema: #/definitions/entTituloPagar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entTituloPagar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entTituloPagar/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entTituloPagar responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entParametrosFilial: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entParametrosFilial responses: 200: description: The created resource schema: #/definitions/entParametrosFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entParametrosFilial responses: 200: description: The created resource schema: #/definitions/entParametrosFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/entParametrosFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entParametrosFilial/{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/entParametrosFilial responses: 200: description: Ok schema: #/definitions/entParametrosFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entParametrosFilial responses: 200: description: Ok schema: #/definitions/entParametrosFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entParametrosFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /dda_debitodiretoautorizado/entities/entParametrosFilial/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entParametrosFilial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: enumTipoOrdenacao: description: Enumeração para o tipo de ordenação type: string enum: – Asc – Desc situacaoImportacao: description: Enumeração para a situação de importação type: string enum: – Processando – Finalizado – Erro – FinalizadoComErros enumOrigemTitulo: description: Enumeração para definição da origem do título type: string enum: – ContasAPagar – NotaFiscalCompra – EntradaFatura – DebitoDiretoAutorizado – Tesouraria – NotaFiscalVenda enumTipoPendencia: description: Enumeração para tipo de pendência DDA type: string enum: – EntradaTitulos – PedidoBaixa – AlteracaoVencimento – Protestar – AlteracaoOutrosDados enumEstadoPendencia: description: Enumeração para estado da pendência type: string enum: – Pendentes – Inconsistentes – Ambos enumSituacao: description: Enumeração para situação type: string enum: – Ativo – Inativo enumSituacaoProcessoAssociacao: description: Enumeração para processo de associação type: string enum: – Processando – Finalizado – Erro – FinalizadoComErros enumSituacaoIntegracao: description: Enumeração para situação de integração type: string enum: – EmIntegracao – Integrado – ErroIntegracao enumTipoValor: description: Enumeração para tipo de tolerânca na parametrização type: string enum: – Percentual – Valor enumTipoBusca: description: Enumeração para tipo de busca de título à pagar manual type: string enum: – FornecedorValor – FornecedorVencimento – FornecedorValorVencimento enumTipoFornecedor: description: Enumeração para tipo de fornecedor type: string enum: – Fisico – Juridico enumSituacaoAssociacaoPendencia: description: Enumeração para situação de associação type: string enum: – Associar – AguardandoEfetivacao – AguardandoAssociacaoMultiplo – Efetivado – AguardandoAlteracao – Alterado – Erro – Desassociado – InconsistenteToleravelBusca enumTipoAssociacao: description: Enumeração para tipo de associação da pendência type: string enum: – Automatica – AutomaticaTolerancia – AutomaticaCNPJRaiz – AutomaticaCNPJRaizTolerancia – AutomaticaOutraFilial – Manual enumTipoExportacao: description: type: string enum: – XLS – XLSX enumTipoDesconto: description: type: string enum: – Percentual – Valor enumErpFinTesTesourariaSituacao: description: type: string enum: – ATIVO – INATIVO upDown: description: Up or down type: string enum: – UP – DOWN enumTipoValorConsideradoPendencia: description: Tipo de valor a ser considerado na pendência type: string enum: – VALOR_BOLETO – VALOR_LIQUIDO – AMBOS enumStatusAssociacaoTask: description: Status das tarefas de associação type: string enum: – INICIANDO – PROCESSANDO – FINALIZADO – ERRO – CANCELADO 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 recFornecedor: description: Define o registro com os dados do fornecedor type: object required: – id – nomeFornecedor – tipoFornecedor – cpfCnpj – situacao properties: id: type: integer format: int64 description: Código do fornecedor nomeFornecedor: type: string description: Nome do fornecedor tipoFornecedor: type: string allOf: – #/definitions/enumTipoFornecedor description: Tipo do fornecedor – Físico ou Jurídico cpfCnpj: type: integer format: int64 description: CPF ou CNPJ do fornecedor cpfCnpjFormatado: type: string description: CPF ou CNPJ do fornecedor formatado situacao: type: object allOf: – #/definitions/recSituacao description: Situação cadastral do fornecedor recArquivo: description: Define o registro de um arquivo à ser usado na importação de arquivos DDA type: object required: – arquivo – nome properties: arquivo: type: string format: byte description: Arquivo CNAB240 em formato base64 nome: type: string description: Nome do arquivo recTituloAssociado: description: Define o registro com os dados do título e da pendência associados pela rotina de associação de pendências type: object required: – pendencia properties: pendencia: type: object allOf: – #/definitions/recPendencia description: Registro da pendência associada tituloPagar: type: object allOf: – #/definitions/recTituloPagar description: Registro do título à pagar associado recSituacaoAssociacaoPendencia: description: Define o registro que representa a situação de associação da pendência, tendo a enumeração e sua descrição type: object required: – situacao – descricao properties: situacao: type: string allOf: – #/definitions/enumSituacaoAssociacaoPendencia description: Enumeração da situação de associação da pendência descricao: type: string description: Descrição da enumeração recPendencia: description: Define o registro com os dados da pendência type: object required: – id – codigoBarras – vencimento – valor – tipoPendencia – situacaoAssociacao properties: id: type: integer format: int64 description: Identificação da pendência fornecedor: type: object allOf: – #/definitions/recFornecedor description: Estrutura do fornecedor ligado a pendência codigoBarras: type: string description: Código da barras da pendência vencimento: type: string format: date description: Vencimento da pendência valor: type: string description: Valor da pendência tipoPendencia: type: object allOf: – #/definitions/recTipoPendencia description: Tipo da pendência logPendencia: type: object allOf: – #/definitions/recLogPendencia description: Log de associação da pendência filial: type: object allOf: – #/definitions/recFilial description: Filial para associação da pendência documento: type: string description: Código do documento (número do título futuro) enviado pelo fornecedor tipoDesconto: type: string description: Tipo de desconto da pendência valorDesconto: type: string description: Valor do desconto da pendência dataDesconto: type: string format: date description: Data limite de desconto da pendência valorJuros: type: string description: Juros da pendência tipoMulta: type: string description: Tipo da multa valorMulta: type: string description: Valor da multa da pendência percentualMulta: type: string description: Percentual da multa da pendência dataMulta: type: string format: date description: Data de emissão da multa dataImportacao: type: string format: date description: Data da geração da importação da pendência tipoAssociacao: type: object allOf: – #/definitions/recTipoAssociacao description: Tipo de associação realizada no processo de associação dataEmissao: type: string format: date description: Data de emissão da pendência somenteLeitura: type: boolean description: Indica se a pendência é passível de exclusão ou não dataAlteracao: type: string format: date-time description: Data de alteração da pendência usuarioAlteracao: type: string description: Usuário de alteração da pendência nomeArquivoImportacao: type: string description: Nome do arquivo que a pendência foi importada situacaoAssociacao: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Situação de associação da pendência vinculada tipoInscricaoFornecedor: type: string description: Tipo de inscrição do fornecedor (1-Física ou 2-Júridica) multiplosFornecedores: type: boolean description: Indicativo se existe mais de um fornecedor com CPF/CNPJ cadastrado na base de dados cpfCnpjFornecedor: type: integer format: int64 description: CPF/CNPJ do fornecedor da pendência valorAbatimento: type: string description: Valor do abatimento da pendência historicoMovimentacao: type: array items: type: object allOf: – #/definitions/recHistoricoMovimentacao description: Histório da movimentação dataGeracao: type: string format: date-time description: Data de geração da pendência usuario: type: string description: Usuário de geração da pendência bancoId: type: string description: Código do banco recTituloPagar: description: Define o registro com os dados do título à pagar type: object required: – id – filial – fornecedor – tipoTitulo – numeroTitulo – dataEntrada – dataEmissao – valorOriginal – valorAberto – vencimentoOriginal – vencimentoProrrogado – provavelPagamento – previsto – situacao – jurosNegociados – multasNegociadas – descontosNegociados – valorLiquido properties: id: type: integer format: int64 description: Identificação do título a pagar filial: type: object allOf: – #/definitions/recFilial description: Estrutura da filial do título a pagar fornecedor: type: object allOf: – #/definitions/recFornecedor description: Estrutura do fornecedor do título a pagar tipoTitulo: type: object allOf: – #/definitions/recTipoTitulo description: Estrutura do tipo de título do título a pagar origemTitulo: type: object allOf: – #/definitions/recOrigemTitulo description: Origem da criação do título a pagar numeroTitulo: type: string description: Número do título a pagar dataEntrada: type: string format: date description: Data de entrada do título a pagar dataEmissao: type: string format: date description: Data de emissão do título a pagar valorOriginal: type: string description: Valor original do título a pagar valorAberto: type: string description: valor aberto do título a pagar vencimentoOriginal: type: string format: date description: Vencimento original do título a pagar vencimentoProrrogado: type: string format: date description: Vencimento prorrogado do título a pagar provavelPagamento: type: string format: date description: Provavel pagamento do título a pagar previsto: type: string description: Indicativo se o título a pagar é previsto situacao: type: string description: Inditivação da situação do título a pagar outrosNegociados: type: string description: Valor de outros acréscimos do título a pagar outrosDescontos: type: string description: Campo descontinuado: Utilize o descontosNegociados dataAlteracao: type: string format: date-time description: Úlitma data de alteração do título à pagar jurosNegociados: type: string description: Valor dos juros negociados com o fornecedor multasNegociadas: type: string description: Valor das multas negociadas com o fornecedor descontosNegociados: type: string description: Valor dos descontos negociados com o fornecedor valorLiquido: type: string description: Valor líquido do título à pagar observacao: type: string description: Observacao jurosDia: type: string description: Valor dos juros diário valorDesconto: type: string description: Valor desconto título percentualDesconto: type: string description: Percentual desconto título dataDesconto: type: string format: date description: Data desconto título percentualMulta: type: string description: Percentual multa título portador: type: object allOf: – #/definitions/recPortador description: Informações do portador do título documento: type: string description: Documento do título codigoBarras: type: string description: Código de barras do título recEmpresa: description: Define o registro com os dados da empresa type: object required: – id – nome properties: id: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa recFilial: description: Define o registro com os dados da filial type: object required: – id – empresa – filial – nome – fantasia properties: id: type: integer format: int64 description: Identificação da filial empresa: type: object allOf: – #/definitions/recEmpresa description: Estrutura da empresa da filial filial: type: integer format: int64 description: Código da filial nome: type: string description: Nome da filial fantasia: type: string description: Nome fantasia da filial cnpj: type: integer format: int64 description: CNPJ da filial recTipoTitulo: description: Define o registro com os dados dos tipos título type: object required: – id – descricao properties: id: type: string description: Código do tipo de título descricao: type: string description: Descrição do tipo de título recLogPendencia: description: Define o registro com os dados do log da pendência, gerados no processo de associação type: object required: – isPendente – podeBuscar properties: logAssociacao: type: string description: Log da associação da pendência isPendente: type: boolean description: Indicativo se a pendência pode ser associada manualmente podeBuscar: type: boolean description: Indicativo se a pendência pode ser buscada manualmente recSituacao: description: Define o registro com os dados das situações type: object required: – situacao – descricao properties: situacao: type: string allOf: – #/definitions/enumSituacao description: Indicativo da situação descricao: type: string description: Descriação da situação recOrigemTitulo: description: Define o registro com os tipos de origem do título type: object required: – origemTitulo – descricao properties: origemTitulo: type: string allOf: – #/definitions/enumOrigemTitulo description: Enumeração da origem do título descricao: type: string description: Descrição da origem do título recPaginacao: description: Define o registro com os dados de paginação de uma listagem type: object required: – pagina – numeroRegistrosPagina – listaOrdenacao properties: pagina: type: integer format: int64 description: Código da pagina a ser retornada numeroRegistrosPagina: type: integer format: int64 description: Número de registros a serem retornados listaOrdenacao: type: array items: type: object allOf: – #/definitions/recListaOrdenacao minimum: 1 description: Campos da ordenação dos registros a serem pesquisados 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) recAssociacaoPendencia: description: Define o registro com os dados que representam um vínculo de uma pendência e título à pagar type: object required: – pendenciaId – tituloPagarId – dataAlteracaoPendencia – dataAlteracaoTituloPagar properties: processoId: type: string description: Código do processo de associação pendenciaId: type: integer format: int64 description: Código da pendência tituloPagarId: type: integer format: int64 description: Código do título a pagar dataAlteracaoPendencia: type: string format: date-time description: Úlitma data de alteração da pendência dataAlteracaoTituloPagar: type: string format: date-time description: Úlitma data de alteração do título à pagar recTipoPendencia: description: Define o registro com os dados dos tipos de pendência type: object required: – tipoPendencia – codigo properties: tipoPendencia: type: string allOf: – #/definitions/enumTipoPendencia description: Tipo da pendência descricao: type: string description: Descrição do tipo da pendência codigo: type: integer format: int64 description: Código bancário do tipo da pendência recLog: description: Define o registro com os dados do log de importação de um arquivo DDA type: object required: – id – nomeArquivo – banco – dataHora properties: id: type: integer format: int64 description: Identificação do log da importação nomeArquivo: type: string description: Nome do arquivo importado banco: type: object allOf: – #/definitions/recBanco description: Estrutura do banco contido no arquivo dataHora: type: string format: date-time description: Data e hora da importação do arquivo recBanco: description: Define o registro com os dados do banco type: object required: – id – descricao properties: id: type: string description: Código do banco descricao: type: string description: Descrição do banco recParametrizacaoFilial: description: Define o registro com os dados de parametrização de filial type: object properties: parametrizacaoId: type: integer format: int64 description: Código da parametrização da filial filiaisId: type: array items: type: integer format: int64 description: Código das filiais parametrizadas consideraTitulosPrevistos: type: boolean description: Indicativo se a busca de associação irá considerar títulos previstos na filtragem geraTitulosPrevistosPendencias: type: boolean description: Indicativo se é para gerar títulos previstos das pendências que não tiverram associação toleranciaValor: type: string description: Valor da tolerância para busca dos títulos a pagar toleranciaDias: type: integer format: int64 description: Quantidade de dias de tolerância para a busca dos títulos a pagar tipoValor: type: string allOf: – #/definitions/enumTipoValor description: Indicativo de como é para ser aplicada a tolerância de valor buscaPorRaizCNPJ: type: boolean description: Indicativo se é para buscar também por RAIZ de CNPJ os títulos a pagar codigoOutrasFiliaisConsideradas: type: array items: type: integer format: int64 description: Código das filiais a serem utilizadas na busca dos títulos a pagar, caso a pendência não encontre nenhum título na sua filial tipoTituloId: type: string description: Tipo de título padrão para geração dos títulos previstos tiposPendencia: type: array items: type: integer format: int64 description: Tipos de pendências que efetivaram automaticamente consideraVencimentoProrrogado: type: boolean description: Considerar vencimento prorrogado consideraFilialPendencia: type: boolean description: Considerar filial da pendência tiposTituloFiltro: type: array items: type: string description: Tipos de títulos filtrados recLogCancelamento: description: Define o registro com os dados do log gerado no cancelamento do vínculo entre pendência e título à pagar ou exclusão da pendência type: object required: – log – pendenciaId properties: log: type: string description: Log de erro do cancelamento pendenciaId: type: integer format: int64 description: Código da pendência com erro recTipoAssociacao: description: Define o registro com os dados do tipo de associação type: object properties: tipoAssociacao: type: string allOf: – #/definitions/enumTipoAssociacao description: Tipo de associação da pendência descricao: type: string description: Descrição do tipo de associação recPortador: description: Define o registro de portador type: object required: – id – empresaId – portador – descricao properties: id: type: integer format: int64 description: Identificador do portador empresaId: type: integer format: int64 description: Identificador da empresa do portador portador: type: string description: Sigla identificador do portador descricao: type: string description: Descrição adicional do portador recCarteira: description: Define o registro da carteira type: object required: – id – descricao properties: id: type: string description: Identificador da carteira descricao: type: string description: Descrição da carteira recTransacaoContasPagar: description: Define o registro de transação de contas a pagar type: object required: – id – empresaId – transacao – descricao – modulo – tipoMovimento – tipoBaixa properties: id: type: integer format: int64 description: Identificador da transação empresaId: type: integer format: int64 description: Identificador da empresa da transação transacao: type: string description: Sequência de caracteres que identifica a transação descricao: type: string description: Descrição da transação modulo: type: string description: Módulo da transação (tipo) tipoMovimento: type: integer format: int64 description: Tipo do movimento tipoBaixa: type: string description: Tipo de baixa recIdentificadorPendencia: description: Estrutura para definição dos dados para identificação básica da pendência type: object required: – pendenciaId – dataAlteracao properties: pendenciaId: type: integer format: int64 description: Identificador da pendência dataAlteracao: type: string format: date-time description: Última data de alteração da pendência recSituacaoIntegracao: description: Define o registro que representa situação de integração da pendência type: object required: – situacao – descricao – associacao properties: situacao: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Enumeração da situação de integração da pendência descricao: type: string description: Descrição da enumeração logIntegracao: type: string description: Log de erro da integracao associacao: type: object allOf: – #/definitions/recAssociacaoPendencia description: Associação recTituloPagarG5: description: type: object required: – tituloPagarId – empresaId – filialId – fornecedorId – tipoTituloId – numeroTitulo – dataEntrada – transacaoEntrada – dataEmissao – valorOriginal – vencimentoOriginal – vencimentoProrrogado – provavelPagamento – situacao – portadorId – carteiraId – codigoBarras properties: tituloPagarId: type: integer format: int64 description: Identificação do título a pagar empresaId: type: integer format: int64 description: Empresa do título a pagar filialId: type: integer format: int64 description: Filial do título a pagar fornecedorId: type: integer format: int64 description: Fornecedor do título a pagar tipoTituloId: type: string description: Estrutura do tipo de título do título a pagar numeroTitulo: type: string description: Número do título a pagar dataEntrada: type: string format: date description: Data de entrada do título a pagar transacaoEntrada: type: string description: Transação de entrada do título a pagar dataEmissao: type: string format: date description: Data de emissão do título a pagar valorOriginal: type: string description: Valor original do título a pagar vencimentoOriginal: type: string format: date description: Vencimento original do título a pagar vencimentoProrrogado: type: string format: date description: Vencimento prorrogado do título a pagar provavelPagamento: type: string format: date description: Provavel pagamento do título a pagar situacao: type: string description: Indicativo da situação do título a pagar outrosNegociados: type: string description: Valor de outros acréscimos do título a pagar outrosDescontos: type: string description: Valor de outros descontos do título a pagar observacoes: type: array items: type: object allOf: – #/definitions/recObservacaoTitulo description: Observações do título jurosDia: type: string description: Valor de juros por dia portadorId: type: integer format: int64 description: Portador do título a pagar carteiraId: type: string description: Carteira do título a pagar dataDesconto: type: string format: date description: Data limite de desconto tipoDesconto: type: string description: Tipo de desconto a ser concedido valorDesconto: type: string description: Valor do desconto a ser concedido percentualDesconto: type: number format: double description: Percentual de desconto a ser concedido percentualMulta: type: number format: double description: Percentual de multa moedaId: type: string description: Moeda do título a pagar codigoBarras: type: string description: Código de barras observacao: type: string description: Observacao erpxId: type: string description: Identificador erpX recObservacaoTitulo: description: type: object required: – observacao properties: observacao: type: string description: Observação do título usuarioGeracao: type: string description: Usuário de geração dataGeracao: type: string format: date-time description: Data de geração recHistoricoMovimentacao: description: Historico de movimentações type: object required: – situacaoAssociacaoPendencia – tipoAssociacao properties: situacaoAssociacaoPendencia: type: object allOf: – #/definitions/recSituacaoAssociacaoPendencia description: Movimentação tipoAssociacao: type: object allOf: – #/definitions/recTipoAssociacao description: Tipo de associação usuarioGeracao: type: string description: Usuário de geração dataGeracao: type: string format: date-time description: Data de geração recCodigoBarras: description: Estrutura do código de barras type: object required: – vencimento – valor properties: bancoId: type: string description: Código do banco vencimento: type: string format: date description: Vencimento do código de barras valor: type: string description: Valor do código de barras recPendenciaManual: description: Pendência para associação type: object required: – filialId – fornecedorId – tipoPendencia – codigoBarras – vencimento – valor – dataEmissao – documento properties: id: type: integer format: int64 description: Identificador da pendência bancoId: type: string description: Código do banco filialId: type: integer format: int64 description: Filial para associação da pendência fornecedorId: type: integer format: int64 description: Fornecedor ligado a pendência tipoPendencia: type: string allOf: – #/definitions/enumTipoPendencia description: Tipo da pendência codigoBarras: type: string description: Código da barras da pendência vencimento: type: string format: date description: Vencimento da pendência valor: type: string description: Valor da pendência dataEmissao: type: string format: date description: Data de emissão da pendência documento: type: string description: Código do documento (número do título futuro) enviado pelo fornecedor tipoDesconto: type: string allOf: – #/definitions/enumTipoDesconto description: Tipo de desconto da pendência valorDesconto: type: string description: Valor do desconto da pendência dataDesconto: type: string format: date description: Data limite de desconto da pendência valorJuros: type: string description: Juros da pendência percentualMulta: type: string description: Percentual da multa da pendência dataMulta: type: string format: date description: Data de emissão da multa valorAbatimento: type: string description: Valor do abatimento da pendência recNomeArquivo: description: Define o nome dos arquivos a serem filtrados na consulta de boletos associados e não associados type: object properties: nomeArquivo: type: string description: Lista de nomes dos arquivos a serem filtrados ticked: type: boolean description: Campo para assinalar se está marcado 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 recErpFinTesTesourariaBanco: description: type: object required: – banco – descricao – abreviatura – segmento – cnpj properties: banco: type: string description: descricao: type: string description: abreviatura: type: string description: segmento: type: string description: cnpj: type: integer format: int64 description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recErpFinTesTesourariaAgencia: description: type: object required: – banco – agencia – abreviatura – descricao properties: banco: type: string description: agencia: type: string description: abreviatura: type: string description: descricao: type: string description: cep: type: integer format: int64 description: logradouro: type: string description: numero: type: string description: complemento: type: string description: bairro: type: string description: cidade: type: string description: estado: type: string description: telefone: type: string description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: recErpFinTesTesourariaContaInterna: description: type: object required: – empresa – contaInterna – descricao – abreviatura properties: empresa: type: integer format: int64 description: contaInterna: type: string description: descricao: type: string description: abreviatura: type: string description: banco: type: string description: agencia: type: string description: tipoConta: type: string description: numeroContaBanco: type: string description: filial: type: array items: type: integer format: int64 description: moeda: type: string description: digitoVerificador: type: string description: limiteCredito: type: string description: dataAbertura: type: string format: date description: situacao: type: string allOf: – #/definitions/enumErpFinTesTesourariaSituacao description: filialIdPadrao: type: integer format: int64 description: usuarioGerador: type: string description: dataGeracao: type: string format: date-time description: usuarioAlteracao: type: string description: dataAlteracao: type: string format: date-time description: entEspecieTipoTitulo: description: Espécie Tipo titulo type: object required: – codigoBanco – codigoProtesto – descricao properties: id: type: integer format: int64 description: codigoBanco: type: string description: Código do tipo de título codigoProtesto: type: string description: descricao: type: string description: Descrição da espécie do tipo de título entTipoTitulo: description: Tipo título type: object required: – id – descricao – somaContasReceber – somaContasPagar – aplicacaoTipo – situacao properties: id: type: string description: Código do tipo de título descricao: type: string description: Descrição do tipo de título somaContasReceber: type: string description: Indicativo títulos do contas a receber desse tipo somam saldo geral financeiro somaContasPagar: type: string description: Indicativo títulos do contas a pagar desse tipo somam saldo geral financeiro aplicacaoTipo: type: string description: Indicativo da aplicação do tipo de título somaBaseImposto: type: string description: Indicativo se o título desse tipo somam na base de impostos geraDctf: type: string description: Gera declaração de débitos e créditos tributários federais (DCTF) situacao: type: string description: Situação do tipo de título especieTipoTituloId: type: integer format: int64 description: Código da espécie do tipo de título usuarioGeracao: type: string description: Usuário que cadastrou o tipo de título dataGeracao: type: string format: date-time description: Data de cadastro do tipo de título usuarioAlteracao: type: string description: Usuário que alterou o tipo de título dataAlteracao: type: string format: date-time description: Data de alteração do tipo de título entFornecedor: description: Fornecedor type: object required: – nomeFornecedor – tipoFornecedor – cpfCnpj – situacao properties: id: type: integer format: int64 description: Código do fornecedor nomeFornecedor: type: string description: Nome do fornecedor tipoFornecedor: type: string allOf: – #/definitions/enumTipoFornecedor description: Tipo do fornecedor cpfCnpj: type: integer format: int64 description: CPF / CNPJ do fornecedor situacao: type: string allOf: – #/definitions/enumSituacao description: Situação do fornecedor entTituloPagar: description: Titulo a pagar type: object required: – empresaId – filialId – fornecedorId – tipoTituloId – origemTitulo – dataEntrada – dataEmissao – valorOriginal – vencimentoOriginal – previsto – situacaoTitulo – portadorId – carteiraId properties: id: type: integer format: int64 description: Identificação do título a pagar empresaId: type: integer format: int64 description: Código da empresa do título a pagar filialId: type: integer format: int64 description: Código da filial do título a pagar fornecedorId: type: integer format: int64 description: Código do fornecedor do título a pagar tipoTituloId: type: string description: Código do tipo de título do título a pagar origemTitulo: type: string allOf: – #/definitions/enumOrigemTitulo description: Origem do título a pagar numeroTitulo: type: string description: Número do título a pagar dataEntrada: type: string format: date description: Data de entrada do título a pagar dataEmissao: type: string format: date description: Data de emissão do título a pagar valorOriginal: type: string description: Valor original do título a pagar valorAberto: type: string description: Valor aberto do título a pagar codigoBarras: type: string description: Código de barras do título a pagar transacaoContasPagar: type: string description: Transação de entrada do título a pagar vencimentoOriginal: type: string format: date description: Vencimento original do título a pagar vencimentoProrrogado: type: string format: date description: Vencimento prorrogado do título a pagar provavelPagamento: type: string format: date description: Provável pagamento do título a pagar previsto: type: string description: Indicativo se o título a pagar é previsto codigoFilial: type: integer format: int64 description: Código da filial do título a pagar situacaoTitulo: type: string description: Situação do título a pagar usuarioGeracao: type: string description: Usuário de cadastro do tipo de título dataGeracao: type: string format: date-time description: Data de cadastro do tipo de título usuarioAlteracao: type: string description: Usuário que alterou o tipo de título dataAlteracao: type: string format: date-time description: Data de alteração do tipo de título portadorId: type: integer format: int64 description: Código do portador do título à pagar carteiraId: type: string description: Código da carteira do título à pagar observacao: type: string description: Observação entParametrosFilial: description: Parâmetros por filial type: object required: – filiaisId properties: id: type: integer format: int64 description: Código da parametrização empresasId: type: array items: type: integer format: int64 description: Empresas parametrização filiaisId: type: array items: type: integer format: int64 minimum: 1 description: Códigos das filias parametrizadas consideraTitulosPrevistos: type: boolean description: Indicativo se a busca de associação irá considerar títulos previstos na filtragem geraTitulosPrevistosPendencias: type: boolean description: Indicativo se é para gerar títulos previstos das pendências que não tiverram associação toleranciaValor: type: string description: Valor da tolerância para busca dos títulos a pagar toleranciaDias: type: integer format: int64 description: Quantidade de dias de tolerância para a busca dos títulos a pagar tipoValor: type: string allOf: – #/definitions/enumTipoValor description: Indicativo de como é para ser aplicada a tolerância de valor buscaPorRaizCNPJ: type: boolean description: Indicativo se é para buscar também por RAIZ de CNPJ os títulos a pagar codigoOutrasFiliaisConsideradas: type: array items: type: integer format: int64 description: Código das filiais a serem utilizadas na busca dos títulos a pagar, caso a pendência\nnão encontre nenhum título na sua filial tipoTituloId: type: string description: Tipo de título padrão para geração dos títulos previstos portadorId: type: integer format: int64 description: Portador padrão para geração de títulos e movimentos carteiraId: type: string description: Carteira padrão para geração de títulos e movimentos transacaoEntradaId: type: integer format: int64 description: Transação de entrada padrão para geração de títulos e movimentos de entrada efetivaAutomaticamente: type: boolean description: Indicativo se é para realizar a efetivação automática de vínculos de pendências e títulos associaAutomaticamenteMultiplosTitulos: type: boolean description: Indicativo se é para associar automaticamente pendências das quais encontram mais de um título (múltiplos) consideraValorLiquidoAssociacao: type: boolean description: Indicativo se é para considerar o valor líquido para associação descricao: type: string description: Descrição da parametrização dataAlteracao: type: string format: date-time description: Data de alteração da parametrização ultimoUsuario: type: string description: Nome do último usuario que alterou a parametrização tiposPendencia: type: array items: type: integer format: int64 description: Tipos de pendências que efetivaram automaticamente consideraVencimentoProrrogado: type: boolean description: Considerar vencimento prorrogado consideraFilialPendencia: type: boolean description: Considerar filial da pendência tiposTituloFiltro: type: array items: type: string description: Tipos de títulos filtrados tipoValorConsideradoPendencia: type: string allOf: – #/definitions/enumTipoValorConsideradoPendencia description: Tipo de valor a ser considerado na pendência – Opcional(quando não informado assume VALOR_LIQUIDO) vencimentoFixo: type: boolean description: Não altera a data de vencimento do título na G5 valorFixo: type: boolean description: Não altera valores do título na G5 notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação