darf

2.0info: 1.8.0 darf description: Serviço responsável pelos processos de DARF do Banking x-senior-domain: Domínio de pagamentos do banking x-senior-domain-path: erpx_bnk_pag x-senior-service-path: darf 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/erpx_bnk_pagsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /darf/queries/healthcheck: post: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/listTitulosPagamentoDarf: post: description: Query de listagem dos títulos de pagamento DARF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – pageRequest properties: filtro: type: object allOf: – #/definitions/recFiltroTitulosPagamentoDarf description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recTituloPagamentoDarf description: Lista de títulos totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/getAcompanhamentoPagamentoDarf: post: description: Query responsável pelas informações de acompanhamento do pagamento de DARF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: object allOf: – #/definitions/recFiltroTitulosPagamentoDarf description: Filtro responses: 200: description: Ok schema: type: object required: – quantidadeTotalDarfsRegistrados – valorTotal – valorTotalAgendado – valorTotalLiquidado properties: quantidadeTotalDarfsRegistrados: type: integer format: int64 description: Quantidade de Darfs registrados valorTotal: type: string description: Valor total valorTotalAgendado: type: string description: Valor total em aberto valorTotalLiquidado: type: string description: Valor total liquidado valoresBanco: type: array items: type: object allOf: – #/definitions/recValorBanco description: Lista de valores agrupados por banco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/getDetalhesTituloPagamentoDarf: post: description: Query responsável por retornar todas as informações relacionadas a um título de pagamento de DARF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagamentoItemDarfId properties: pagamentoItemDarfId: type: string description: Identificador do registro responses: 200: description: Ok schema: type: object required: – pagamentoItemDarfId – tituloId – dadosGerais – dadosDarf – dadosValor properties: pagamentoItemDarfId: type: string description: Identificador do registro tituloId: type: string description: Identificador do título dadosGerais: type: object allOf: – #/definitions/recDadosGeraisDetalhesTituloPagamentoDarf description: Informações gerais dadosDarf: type: object allOf: – #/definitions/recDadosDarfDetalhesTituloPagamentoDarf description: Informações do Darf dadosValor: type: object allOf: – #/definitions/recDadosValorDetalhesTituloPagamentoDarf description: Informações dos valores dadosLiquidacao: type: object allOf: – #/definitions/recDadosLiquidacaoDetalhesTituloPagamentoDarf description: Informações da liquidação historicosTitulo: type: array items: type: object allOf: – #/definitions/recHistoricoDetalhesTituloPagamentoDarf description: Históricos do título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query responsável por retornar todas as informações relacionadas a um título de pagamento de DARF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pagamentoItemDarfId description: Identificador do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – pagamentoItemDarfId – tituloId – dadosGerais – dadosDarf – dadosValor properties: pagamentoItemDarfId: type: string description: Identificador do registro tituloId: type: string description: Identificador do título dadosGerais: type: object allOf: – #/definitions/recDadosGeraisDetalhesTituloPagamentoDarf description: Informações gerais dadosDarf: type: object allOf: – #/definitions/recDadosDarfDetalhesTituloPagamentoDarf description: Informações do Darf dadosValor: type: object allOf: – #/definitions/recDadosValorDetalhesTituloPagamentoDarf description: Informações dos valores dadosLiquidacao: type: object allOf: – #/definitions/recDadosLiquidacaoDetalhesTituloPagamentoDarf description: Informações da liquidação historicosTitulo: type: array items: type: object allOf: – #/definitions/recHistoricoDetalhesTituloPagamentoDarf description: Históricos do título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/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 /darf/queries/exportPagamentoDadosDarf: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportPagamentoItemDarf: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportPagamentoItemDarfHistorico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportPagamentoItemDarfErro: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportPagamentoItemDarfRegistro: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportOcorrenciaBanco: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportPagamentoItemDarfHistoricoOcorrencia: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/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 /darf/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/getTablesWithForeignKeyReferences: post: description: Retorna quais tabelas possuem Foreign Keys para a tabela informada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tableNames properties: tableNames: type: array items: type: string minimum: 1 description: Nomes das tabelas responses: 200: description: Ok schema: type: object required: – tablesReferences properties: tablesReferences: type: array items: type: object allOf: – #/definitions/tableForeignKeyReference minimum: 1 description: Lista de tabelas referenciadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/agendarPagamentoEletronico: post: description: Primitiva responsável por agendar pagamento eletrônico tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulosId properties: titulosId: type: array items: type: string minimum: 1 description: Lista dos IDs dos títulos que terão os pagamentos agendados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importPagamentoDadosDarf: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importPagamentoItemDarf: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importPagamentoItemDarfHistorico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importPagamentoItemDarfErro: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importPagamentoItemDarfRegistro: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importOcorrenciaBanco: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importPagamentoItemDarfHistoricoOcorrencia: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/signals/registrarPagamentoDarfAsync: post: description: API responsável pela criação do registro de pagamento assíncrono de DARF tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – banco – filialId – dadosBancarios – titulos properties: banco: type: string allOf: – #/definitions/enumBancoPagamento description: Banco do pagamento filialId: type: string description: Identificador da filial dadosBancarios: type: object allOf: – #/definitions/recDadosBancarios description: Dados bancários do pagamento titulos: type: array items: type: object allOf: – #/definitions/recTituloRegistroPagamentoAsync minimum: 1 description: Lista de títulos que serão agendado os pagamentos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/signals/executarIntegracaoParceiro: post: description: Signal responsável pela chamada do parceiro bancário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId properties: loteId: type: string description: Identificador do lote de processamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/signals/finalizarPagamento: post: description: Signal responsável pela finalização da etapa inicial do pagamento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId properties: loteId: type: string description: Identificador do lote de processamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/signals/retornoPagamentoEstornado: post: description: Signal responsável pelo retorno de pagamentos estornados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – seuNumero properties: seuNumero: type: array items: type: string minimum: 1 description: Seu número responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/signals/retornoConfirmacaoAgendamento: post: description: Signal responsável pela confirmação do agendamento do pagamento no banco tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pagamentos properties: pagamentos: type: array items: type: object allOf: – #/definitions/recRetornoPagamentoAgendado minimum: 1 description: Lista de pagamentos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/signals/retornoPagamentoEfetuado: post: description: Signal responsável pela confirmação de liquidação dos pagamentos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pagamentos properties: pagamentos: type: array items: type: object allOf: – #/definitions/recRetornoPagamentoEfetuado minimum: 1 description: Lista de pagamentos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/signals/retornoPagamentoCancelado: post: description: Signal responsável pelo retorno de pagamentos cancelados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – seuNumero properties: seuNumero: type: array items: type: string minimum: 1 description: Seu número responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/signals/retornoAprovacaoPagamento: post: description: Signal responsável pelo retorno de pagamentos em aprovação tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pagamentos properties: pagamentos: type: array items: type: object allOf: – #/definitions/recRetornoAprovacaoPagamento minimum: 1 description: Lista de pagamentos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /darf/events/iniciarIntegracaoPagamentoDarfBtg: post: description: Evento responsável pela chamada da integração com o parceiro BTG x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – pagador – pagamentos properties: pagador: type: object allOf: – #/definitions/recPagadorBtg description: Informações do pagador do pagamento pagamentos: type: array items: type: object allOf: – #/definitions/recPagamentoBtg minimum: 1 description: Lista de pagamentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/darfScheduled: post: description: Evento público responsável pela retorno do agendamento do DARF no banco x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountsPayable properties: accountsPayable: type: array items: type: object allOf: – #/definitions/recAccountsPayableScheduled minimum: 1 description: Lista de pagamentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/darfCanceled: post: description: Evento público responsável pelo retorno do cancelamento do DARF no banco x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountPayableId properties: accountPayableId: type: array items: type: string minimum: 1 description: Identificador dos títulos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/darfPaid: post: description: Evento público responsável pela retorno do pagamento do DARF x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountsPayable properties: accountsPayable: type: array items: type: object allOf: – #/definitions/recAccountsPayablePaidOff minimum: 1 description: Lista de pagamentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/darfApproval: post: description: Evento público responsável pelo retorno da aprovação do DARF no banco x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountsPayable properties: accountsPayable: type: array items: type: object allOf: – #/definitions/recAccountsPayableApproval minimum: 1 description: Lista de pagamentos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/darfReverted: post: description: Evento público responsável pelo retorno do estorno do DARF no banco x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountPayableId properties: accountPayableId: type: array items: type: string minimum: 1 description: Identificador dos títulos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importPagamentoDadosDarfEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportPagamentoDadosDarfEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importPagamentoItemDarfEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportPagamentoItemDarfEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importPagamentoItemDarfHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportPagamentoItemDarfHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importPagamentoItemDarfErroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportPagamentoItemDarfErroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importPagamentoItemDarfRegistroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportPagamentoItemDarfRegistroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importOcorrenciaBancoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportOcorrenciaBancoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importPagamentoItemDarfHistoricoOcorrenciaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportPagamentoItemDarfHistoricoOcorrenciaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoDadosDarf: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoDadosDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarf: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoDadosDarf/{parentId}/pagamentoItemDarf: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarf responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarf responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoDadosDarf/{parentId}/pagamentoItemDarf/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPagamentoItemDarf responses: 200: description: Ok schema: #/definitions/editPagamentoItemDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pagamentoItemDarf responses: 200: description: Ok schema: #/definitions/pagamentoItemDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pagamentoItemDarf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarfHistorico: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfHistoricos: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarfHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarfHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfHistoricos/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPagamentoItemDarfHistorico responses: 200: description: Ok schema: #/definitions/editPagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pagamentoItemDarfHistorico responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarfErro: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfErros: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarfErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarfErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfErros/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPagamentoItemDarfErro responses: 200: description: Ok schema: #/definitions/editPagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pagamentoItemDarfErro responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarfRegistro: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfRegistro: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/pagamentoItemDarfRegistro responses: 200: description: The created resource schema: #/definitions/pagamentoItemDarfRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/pagamentoItemDarfRegistro responses: 200: description: The created resource schema: #/definitions/pagamentoItemDarfRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfRegistro/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPagamentoItemDarfRegistro responses: 200: description: Ok schema: #/definitions/editPagamentoItemDarfRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pagamentoItemDarfRegistro responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/ocorrenciaBanco: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/ocorrenciaBanco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarfHistoricoOcorrencia: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfHistoricoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarfHistorico/{parentId}/pagamentoItemDarfHistoricoOcorrencias: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarfHistoricoOcorrencia responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfHistoricoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/pagamentoItemDarfHistoricoOcorrencia responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfHistoricoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pagamentoItemDarfHistoricoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/pagamentoItemDarfHistorico/{parentId}/pagamentoItemDarfHistoricoOcorrencias/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPagamentoItemDarfHistoricoOcorrencia responses: 200: description: Ok schema: #/definitions/editPagamentoItemDarfHistoricoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/pagamentoItemDarfHistoricoOcorrencia responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfHistoricoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfHistoricoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/e070emp: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/e070fil: get: description: Esta entidade pode ser customizada. 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /darf/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumBancoPagamento: type: string enum: – BTG_PACTUAL description: Enumeration de bancos de pagamento: * `BTG_PACTUAL` – BTG Pactual – 208 enumSituacaoPagamentoDados: type: string enum: – PROCESSANDO – FINALIZADO description: Enumeration da situação do registro de pagamento dados: * `PROCESSANDO` – Processando * `FINALIZADO` – Finalizado enumSituacaoPagamentoItem: type: string enum: – AGUARDANDO_PAGAMENTO – PROCESSANDO_ENVIO_PAGAMENTO – PAGAMENTO_AGENDADO – PAGAMENTO_CANCELADO – PAGAMENTO_ESTORNADO – PAGAMENTO_NAO_AGENDADO – PAGAMENTO_EFETUADO – PAGAMENTO_COM_PROBLEMAS – PAGAMENTO_INAPTO_PARA_PROCESSAMENTO – PAGAMENTO_APROVACAO_PENDENTE – PAGAMENTO_APROVADO – ERRO_INESPERADO – PAGAMENTO_INATIVADO – FALHA_NA_VALIDACAO – PENDENTE_ENVIO_AO_BANCO description: Enumeration de situação do pagamento item: * `AGUARDANDO_PAGAMENTO` – Aguardando pagamento * `PROCESSANDO_ENVIO_PAGAMENTO` – Processando envio pagamento * `PAGAMENTO_AGENDADO` – Pagamento agendado * `PAGAMENTO_CANCELADO` – Pagamento cancelado * `PAGAMENTO_ESTORNADO` – Pagamento estornado * `PAGAMENTO_NAO_AGENDADO` – Pagamento não agendado * `PAGAMENTO_EFETUADO` – Pagamento efetuado * `PAGAMENTO_COM_PROBLEMAS` – Pagamento com problemas * `PAGAMENTO_INAPTO_PARA_PROCESSAMENTO` – Pagamento inapto para processamento * `PAGAMENTO_APROVACAO_PENDENTE` – Pagamento pendente de aprovação * `PAGAMENTO_APROVADO` – Pagamento aprovado * `ERRO_INESPERADO` – Erro inesperado * `PAGAMENTO_INATIVADO` – Pagamento inativado * `FALHA_NA_VALIDACAO` – Falha na validação * `PENDENTE_ENVIO_AO_BANCO` – Pendente envio ao banco enumSituacaoPagamentoItemDetalhes: type: string enum: – PAGAMENTO_VALIDADO – PROCESSANDO_ENVIO_PAGAMENTO – PAGAMENTO_ENVIADO – PAGAMENTO_CANCELADO – PAGAMENTO_ESTORNADO – PAGAMENTO_COM_PROBLEMAS – PAGAMENTO_AGENDADO – PAGAMENTO_APROVADO – PAGAMENTO_APROVACAO_PENDENTE – PAGAMENTO_NAO_AGENDADO – PAGAMENTO_EFETUADO – FALHA_NA_VALIDACAO description: Enumeration de situação dos detalhes do pagamento item: * `PAGAMENTO_VALIDADO` – Pagamento validado * `PROCESSANDO_ENVIO_PAGAMENTO` – Processando envio do pagamento * `PAGAMENTO_ENVIADO` – Pagamento enviado * `PAGAMENTO_CANCELADO` – Pagamento cancelado * `PAGAMENTO_ESTORNADO` – Pagamento estornado * `PAGAMENTO_COM_PROBLEMAS` – Pagamento com problemas * `PAGAMENTO_AGENDADO` – Pagamento agendado * `PAGAMENTO_APROVADO` – Pagamento aprovado * `PAGAMENTO_APROVACAO_PENDENTE` – Pagamento pendente de aprovação * `PAGAMENTO_NAO_AGENDADO` – Pagamento não agendado * `PAGAMENTO_EFETUADO` – Pagamento efetuado * `FALHA_NA_VALIDACAO` – Falha na validação enumOrigemErro: type: string enum: – BANKING – PARCEIRO – BANCO description: Enumeration da origem do erro do título: * `BANKING` – Banking * `PARCEIRO` – Parceiro * `BANCO` – Banco enumSituationScheduled: type: string enum: – SCHEDULED – NOT_SCHEDULED description: Situação do agendamento do pagamento: * `SCHEDULED` – Agendado * `NOT_SCHEDULED` – Não agendado enumSituationApproval: type: string enum: – APPROVED – PENDING_APPROVAL description: Situação da aprovação do pagamento: * `APPROVED` – Aprovado * `PENDING_APPROVAL` – Aprovação pendente enumStatusIntegracaoParceiro: type: string enum: – ENVIADO_AO_BANCO – FALHA_NO_ENVIO_AO_BANCO – INCLUIDO – REJEITADO – LIQUIDADO – APROVADO – APROVACAO_PENDENTE description: Enumeration do status de integração com parceiro: * `ENVIADO_AO_BANCO` – Enviado ao banco * `FALHA_NO_ENVIO_AO_BANCO` – Falha no envio ao banco * `INCLUIDO` – Incluído * `REJEITADO` – Rejeitado * `LIQUIDADO` – Liquidado * `APROVADO` – Aprovado * `APROVACAO_PENDENTE` – Pendente de aprovação enumTypeOrder: type: string enum: – ASC – DESC description: Enumeração para o tipo de ordenação: * `ASC` – Tipo de ordenação – Crescente * `DESC` – Tipo de ordenação – Decrescente enumStatusPagamentoItemTela: type: string enum: – APROVADO – APROVACAO_PENDENTE – PROCESSANDO – AGENDADO – RECUSADO – PAGO – ERRO – CANCELADO – ESTORNADO – PENDENTE_ENVIO_AO_BANCO description: Enumeration dos status do título apresentado na tela: * `APROVADO` – Aprovado * `APROVACAO_PENDENTE` – Aprovação pendente * `PROCESSANDO` – Processando * `AGENDADO` – Agendado * `RECUSADO` – Recusado * `PAGO` – Pago * `ERRO` – Erro * `CANCELADO` – Cancelado * `ESTORNADO` – Estornado * `PENDENTE_ENVIO_AO_BANCO` – Pendente de envio ao banco userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error 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 recValorBanco: description: Record de informações de valores por banco do pagamento de DARF type: object required: – banco – quantidadeDarfRegistrado – valorAgendado – valorLiquidado – valorTotal properties: banco: type: string allOf: – #/definitions/enumBancoPagamento description: Banco quantidadeDarfRegistrado: type: integer format: int64 description: Quantidade de DARF registrado valorAgendado: type: string description: Valor agendado valorLiquidado: type: string description: Valor liquidado valorTotal: type: string description: Valor total recDadosBancarios: description: Record de dados bancários do pagamento type: object required: – agencia – contaCorrente properties: agencia: type: string maxLength: 5 description: Número da agência digitoAgencia: type: string maxLength: 2 description: Dígito da agência contaCorrente: type: string maxLength: 12 description: Número da conta digitoContaCorrente: type: string maxLength: 2 description: Dígito da conta recAccountsPayablePaidOff: description: Record com os dados de liquidação do pagamento de DARF type: object required: – accountPayableId – payDate – amountPaid properties: accountPayableId: type: string description: Identificador do título payDate: type: string format: date description: Data de pagamento amountPaid: type: string description: Valor do pagamento bankAutentication: type: string description: Autenticação bancária occurrences: type: array items: type: object allOf: – #/definitions/recOcurrence description: Ocorrências recAccountsPayableApproval: description: Record com os dados da aprovação do pagamento de DARF type: object required: – accountPayableId – situation properties: accountPayableId: type: string description: Identificador do título situation: type: string allOf: – #/definitions/enumSituationApproval description: Situação da aprovação do pagamento recFavorecido: description: Record do favorecido type: object required: – nome – numeroDocumento properties: nome: type: string description: Nome do favorecido numeroDocumento: type: string maxLength: 14 description: Documento do favorecido recValoresTitulo: description: Record de valores do título do pagamento type: object required: – original – principal properties: original: type: string description: Valor original principal: type: string description: Principal juros: type: string description: Juros multa: type: string description: Multas recTituloRegistroPagamentoAsync: description: Record com as informações do título para registro de pagamento type: object required: – tituloId – numeroTitulo – tipoTitulo – codigoReceita – periodoApuracao – favorecido – dataVencimento – dataPagamento – valores – seuNumero properties: tituloId: type: string description: Identificador do título numeroTitulo: type: string description: Número do título tipoTitulo: type: string description: Tipo do título codigoReceita: type: string description: Código da receita periodoApuracao: type: string format: date description: Período de apuração favorecido: type: object allOf: – #/definitions/recFavorecido description: Favorecido dataVencimento: type: string format: date description: Data de vencimento dataPagamento: type: string format: date description: Data de pagamento valores: type: object allOf: – #/definitions/recValoresTitulo description: Valores seuNumero: type: string description: Seu número recPagadorBtg: description: Record das informações do pagador (BTG) type: object required: – nome – cnpj – agencia – numeroConta properties: nome: type: string description: Nome cnpj: type: string description: CNPJ agencia: type: string description: Agência numeroConta: type: string description: Número da Conta recPagamentoBtg: description: Record com as informações do título para pagamento (BTG) type: object required: – codigoReceita – seuNumero – dataVencimento – dataPagamento – valores – periodoApuracao properties: codigoReceita: type: string description: Código da Receita seuNumero: type: string description: Seu número dataVencimento: type: string format: date description: Data de vencimento dataPagamento: type: string format: date description: Data de pagamento valores: type: object allOf: – #/definitions/recValorBtg description: Valor do pagamento periodoApuracao: type: string format: date description: Período de apuração recValorBtg: description: Record com as informações de valores do pagamento (BTG) type: object required: – original properties: original: type: string description: Valor original multa: type: string description: Valor da multa juros: type: string description: Valor dos juros principal: type: string description: Valor do principal recAccountsPayableScheduled: description: Record com os dados do agendamento do pagamento de DARF type: object required: – accountPayableId – situation properties: accountPayableId: type: string description: Identificador do título situation: type: string allOf: – #/definitions/enumSituationScheduled description: Situação do agendamento do pagamento occurrences: type: array items: type: object allOf: – #/definitions/recOcurrence description: Ocorrências errors: type: array items: type: object allOf: – #/definitions/recError description: Lista de erros no agendamento da DARF recOcurrence: description: Record com as infomações da ocorrência type: object required: – code – description properties: code: type: string description: Código description: type: string description: Descrição recError: description: Record com informações de erro da DARF type: object required: – message properties: message: type: string description: Mensagem de erro field: type: string description: Campo do erro recRetornoPagamentoAgendado: description: Record com os dados de agendamento do DARF type: object required: – seuNumero – status properties: seuNumero: type: string description: Seu número status: type: string allOf: – #/definitions/enumStatusIntegracaoParceiro description: Status ocorrencias: type: array items: type: string description: Ocorrências recRetornoPagamentoEfetuado: description: Record com os dados de liquidação do DARF type: object required: – seuNumero – valorPago – dataLiquidacao properties: seuNumero: type: string description: Seu número valorPago: type: string description: Valor pago dataLiquidacao: type: string format: date description: Data de liquidação autenticacaoBancaria: type: string description: Autenticação bancária ocorrencias: type: array items: type: string description: Ocorrências recRetornoAprovacaoPagamento: description: Record com os dados de aprovação do DARF ao banco type: object required: – seuNumero – status properties: seuNumero: type: string description: Seu número status: type: string allOf: – #/definitions/enumStatusIntegracaoParceiro description: Status recFiltroTitulosPagamentoDarf: description: Record do filtro de títulos de pagamento DARF type: object required: – empresaId – filiaisId properties: empresaId: type: string description: Identificador da empresa filiaisId: type: array items: type: string minimum: 1 description: Identificadores da filiais documentoFavorecido: type: string maxLength: 14 description: Documento do favorecido nomeFavorecido: type: string description: Nome do favorecido bancos: type: array items: type: string allOf: – #/definitions/enumBancoPagamento description: Banco status: type: array items: type: string allOf: – #/definitions/enumStatusPagamentoItemTela description: Status numeroTitulo: type: string description: Título tipoTitulo: type: string description: Tipo de título numeroContaPagador: type: string maxLength: 12 description: Número da conta do pagador valorMinimo: type: string description: Valor original mínimo valorMaximo: type: string description: Valor original máximo dataEmissaoInicial: type: string format: date description: Data de emissão inicial dataEmissaoFinal: type: string format: date description: Data de emissão final dataPagamentoInicial: type: string format: date description: Data de pagamento inicial dataPagamentoFinal: type: string format: date description: Data de pagamento final dataLiquidacaoInicial: type: string format: date description: Data de liquidação inicial dataLiquidacaoFinal: type: string format: date description: Data de liquidação final dataVencimentoInicial: type: string format: date description: Data de vencimento inicial dataVencimentoFinal: type: string format: date description: Data de vencimento final periodoApuracaoInicial: type: string format: date description: Período de apuração inicial periodoApuracaoFinal: type: string format: date description: Período de apuração final codigoReceita: type: string description: Código da receita recPageRequest: description: Record para paginação e ordenação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recTituloPagamentoDarf: description: Record com as informações do título de pagamento Darf type: object required: – pagamentoItemDarfId – tituloId – empresa – filial – nomeFavorecido – documentoFavorecido – tipoTitulo – numeroTitulo – dataEmissao – dataVencimento – dataPagamento – valorOriginal – banco – status properties: pagamentoItemDarfId: type: string description: Identificador do registro de pagamento item Darf tituloId: type: string description: Identificador do título empresa: type: object allOf: – #/definitions/recGenerico description: Empresa filial: type: object allOf: – #/definitions/recGenerico description: Filial nomeFavorecido: type: string description: Nome do favorecido documentoFavorecido: type: string description: Documento do favorecido tipoTitulo: type: string description: Tipo do título numeroTitulo: type: string description: Número do título dataEmissao: type: string format: date description: Data de emissão dataVencimento: type: string format: date description: Data de vencimento dataPagamento: type: string format: date description: Data de pagamento dataLiquidacao: type: string format: date description: Data de liquidação valorOriginal: type: string description: Valor original banco: type: string allOf: – #/definitions/enumBancoPagamento description: Banco status: type: string allOf: – #/definitions/enumStatusPagamentoItemTela description: Status periodoApuracao: type: string format: date description: Período de apuracao codigoReceita: type: string description: Código da receita recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id properties: id: type: string description: Identificador da entidade codigo: type: string description: Código de negócio descricao: type: string description: Descrição de negócio label: type: string description: Descrição do label recDadosGeraisDetalhesTituloPagamentoDarf: description: Record com os dados gerais da primitiva de detalhes de pagamento DARF type: object required: – empresa – filial – banco – numeroAgencia – numeroConta properties: empresa: type: object allOf: – #/definitions/recGenerico description: Empresa filial: type: object allOf: – #/definitions/recGenerico description: Filial banco: type: string allOf: – #/definitions/enumBancoPagamento description: Banco numeroAgencia: type: string description: Número da agência digitoAgencia: type: string description: Dígito da agência numeroConta: type: string description: Número da conta digitoConta: type: string description: Dígito da conta recDadosDarfDetalhesTituloPagamentoDarf: description: Record com os dados de DARF da primitiva de detalhes de pagamento DARF type: object required: – numeroTitulo – tipoTitulo – nomeFavorecido – documentoFavorecido – dataEmissao – dataVencimento – dataPagamento – periodoApuracao – codigoReceita properties: numeroTitulo: type: string description: Número do título tipoTitulo: type: string description: Tipo de titulo nomeFavorecido: type: string description: Nome do favorecido documentoFavorecido: type: string description: Documento do favorecido dataEmissao: type: string format: date description: Data da emissão dataVencimento: type: string format: date description: Data de vencimento dataPagamento: type: string format: date description: Data de pagamento periodoApuracao: type: string format: date description: Periodo de apuração codigoReceita: type: string description: Código da receita recDadosValorDetalhesTituloPagamentoDarf: description: Record com os dados de valores do título da primitiva de detalhes de pagamento DARF type: object required: – valorOriginal properties: valorOriginal: type: string description: Valor original valorJuros: type: string description: Valor dos juros valorMulta: type: string description: Valor da multa valorPrincipal: type: string description: Valor do principal recDadosLiquidacaoDetalhesTituloPagamentoDarf: description: Record com os dados de liquidação do título da primitiva de detalhes de pagamento DARF type: object required: – dataLiquidacao – valorPago properties: dataLiquidacao: type: string format: date description: Data da liquidação valorPago: type: string description: Valor pago autenticacaoBancaria: type: string description: Autenticação bancária recHistoricoDetalhesTituloPagamentoDarf: description: Record com os históricos do título da primitiva de detalhes de pagamento DARF type: object required: – pagamentoItemDarfHistoricoId – situacao – descricao – dataHoraProcessamento properties: pagamentoItemDarfHistoricoId: type: string description: Identificador do histórico situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItemDetalhes description: Situação descricao: type: string description: Descrição do histórico dataHoraProcessamento: type: string format: date-time description: Data e hora de processamento tableForeignKeyReference: description: Resulado da consulta de tabelas referenciada por uma Foreign Key type: object required: – referenceTableName – tableName – columnName – constraintName properties: referenceTableName: type: string description: Referenced table tableName: type: string description: Tabela referenciada columnName: type: string description: Coluna referenciada pela FK exclusionField: type: string description: Coluna com o campo de exclusão constraintName: type: string description: Nome da ForeignKey pagamentoDadosDarf: description: Entidade de dados do pagamento de DARF type: object required: – loteId – bancoPagamento – filialId – numeroAgencia – numeroConta – situacao properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Identificador do lote bancoPagamento: type: string allOf: – #/definitions/enumBancoPagamento description: Banco utilizado no pagamento filialId: type: string format: uuid description: Identificador da filial numeroAgencia: type: string maxLength: 5 description: Número da agência digitoAgencia: type: string maxLength: 2 description: Dígito da agência numeroConta: type: string maxLength: 12 description: Número da conta digitoConta: type: string maxLength: 2 description: Dígito da conta situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoDados description: Situação codigoLote: type: string description: Código do lote pagamentoItemDarf: type: array items: type: object allOf: – #/definitions/pagamentoItemDarf description: Títulos de pagamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: pagamentoItemDarf: description: Entidade de dados do título do pagamento de DARF type: object required: – tituloId – numeroTitulo – tipoTitulo – codigoReceita – periodoApuracao – seuNumero – documentoFavorecido – nomeFavorecido – dataVencimento – dataPagamento – valorOriginal – situacao properties: id: type: string format: uuid description: Identificador do registro pagamentoDadosDarf: type: object allOf: – #/definitions/pagamentoDadosDarf description: Registro de pagamento de dados darf tituloId: type: string format: uuid description: Identificador do título numeroTitulo: type: string description: Número do título tipoTitulo: type: string description: Tipo do título codigoReceita: type: string description: Código da receita periodoApuracao: type: string format: date description: Período de apuração seuNumero: type: string maxLength: 20 description: Seu número documentoFavorecido: type: string maxLength: 14 description: Documento do favorecido nomeFavorecido: type: string description: Nome do favorecido dataVencimento: type: string format: date description: Data de vencimento dataPagamento: type: string format: date description: Data do pagamento valorOriginal: type: string description: Valor original valorJuros: type: string description: Valor de juros valorMulta: type: string description: Valor de multa valorPrincipal: type: string description: Valor do principal situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItem description: Situação do título pagamentoItemDarfHistoricos: type: array items: type: object allOf: – #/definitions/pagamentoItemDarfHistorico description: Registros de históricos do título pagamentoItemDarfErros: type: array items: type: object allOf: – #/definitions/pagamentoItemDarfErro description: Registros de erros do pagamento pagamentoItemDarfRegistro: type: object allOf: – #/definitions/pagamentoItemDarfRegistro description: Registro do pagamento de DARF usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemDarf: type: object required: – id allOf: – #/definitions/pagamentoItemDarf pagamentoItemDarfHistorico: description: Entidade de histórico do título de pagamento DARF type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro pagamentoItemDarf: type: object allOf: – #/definitions/pagamentoItemDarf description: Registro de pagamento do item DARF situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItemDetalhes description: Situação mensagem: type: string description: Mensagem pagamentoItemDarfHistoricoOcorrencias: type: array items: type: object allOf: – #/definitions/pagamentoItemDarfHistoricoOcorrencia description: Ocorrência usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemDarfHistorico: type: object required: – id allOf: – #/definitions/pagamentoItemDarfHistorico pagamentoItemDarfErro: description: Entidade de dados do título da pagamento DARF com erro type: object required: – motivo – origem properties: id: type: string format: uuid description: Identificador do registro pagamentoItemDarf: type: object allOf: – #/definitions/pagamentoItemDarf description: Registro de pagamento do item DARF campo: type: string description: Campo do erro motivo: type: string description: Motivo origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemDarfErro: type: object required: – id allOf: – #/definitions/pagamentoItemDarfErro pagamentoItemDarfRegistro: description: Entidade com os dados do DARF do título de pagamento type: object required: – dataLiquidacao – valorPago properties: id: type: string format: uuid description: Identificador do registro pagamentoItemDarf: type: object allOf: – #/definitions/pagamentoItemDarf description: Registro de pagamento do item DARF dataLiquidacao: type: string format: date description: Data liquidação valorPago: type: string description: Valor pago autenticacaoBancaria: type: string description: Autenticação bancária usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemDarfRegistro: type: object required: – id allOf: – #/definitions/pagamentoItemDarfRegistro ocorrenciaBanco: description: Entidade de ocorrência do banco type: object required: – codigoBanco – codigo – descricao properties: id: type: string format: uuid description: Identificador da ocorrência codigoBanco: type: string description: Código do banco codigo: type: string description: Código da ocorrência descricao: type: string description: Descrição da ocorrência usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: pagamentoItemDarfHistoricoOcorrencia: description: Entidade de histórico de ocorrência do título de pagamento darf type: object required: – ocorrencia properties: id: type: string format: uuid description: Identificador do registro pagamentoItemDarfHistorico: type: object allOf: – #/definitions/pagamentoItemDarfHistorico description: Registro de pagamento item darf histórico ocorrencia: type: object allOf: – #/definitions/ocorrenciaBanco description: Registro do motivo da ocorrência usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemDarfHistoricoOcorrencia: type: object required: – id allOf: – #/definitions/pagamentoItemDarfHistoricoOcorrencia e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Identificador da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Fantasia numCgc: type: string maxLength: 18 description: CPF/CNPJ numIdf: type: string maxLength: 40 description: Número identificação fiscal excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage