Cobrança Boleto (boleto)

2.0info: 2.14.2 Cobrança Boleto description: Serviço de cobranças via Boleto x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: boleto 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_cobsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /boleto/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 /boleto/queries/listTitulosCobrancaBoleto: post: description: Query de listagem dos títulos de cobrança boleto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filtro: type: object allOf: – #/definitions/recFiltroTitulosCobrancaBoleto 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/recTituloCobrancaBoleto 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 /boleto/queries/getStatusCobrancaBoleto: post: description: Query de listagem do status dos títulos de cobrança boleto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filter: type: object allOf: – #/definitions/recFiltroGetStatusCobrancaBoleto description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – cobrancaDadosBoleto properties: cobrancaDadosBoleto: type: array items: type: object allOf: – #/definitions/recCobrancaDadosBoleto minimum: 1 description: Dados da cobrança boleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/getAcompanhamentoCobrancaBoleto: post: description: Query responsável pelas informações de acompanhamento da cobrança boleto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filtro: type: object allOf: – #/definitions/recFiltroTitulosCobrancaBoleto description: Filtro responses: 200: description: Ok schema: type: object required: – quantidadeTotalRegistroBoleto – valorTotal – valorTotalAberto – valorTotalLiquidado properties: quantidadeTotalRegistroBoleto: type: integer format: int64 description: Quantidade de boleto gerado valorTotal: type: string description: Valor total valorTotalAberto: 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 /boleto/queries/getDetalhesTituloCobrancaBoleto: post: description: Query responsável por retornar todas as informações relacionadas a um título de cobrança boleto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cobrancaItemBoletoId properties: cobrancaItemBoletoId: type: string maxLength: 255 description: Identificador do registro responses: 200: description: Ok schema: type: object required: – cobrancaItemBoletoId – tituloId – dadosGerais – dadosBoleto – dadosValor properties: cobrancaItemBoletoId: type: string maxLength: 255 description: Identificador do registro tituloId: type: string maxLength: 255 description: Identificador do título dadosGerais: type: object allOf: – #/definitions/recDadosGeraisDetalhesTituloCobrancaBoleto description: Informações gerais dadosBoleto: type: object allOf: – #/definitions/recDadosBoletoDetalhesTituloCobrancaBoleto description: Informações do boleto dadosValor: type: object allOf: – #/definitions/recDadosValorDetalhesTituloCobrancaBoleto description: Informações dos valores dadosLiquidacao: type: object allOf: – #/definitions/recDadosLiquidacaoDetalhesTituloCobrancaBoleto description: Informações da liquidação historicosTitulo: type: array items: type: object allOf: – #/definitions/recHistoricoDetalhesTituloCobrancaBoleto 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 cobrança boleto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cobrancaItemBoletoId description: Identificador do registro in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – cobrancaItemBoletoId – tituloId – dadosGerais – dadosBoleto – dadosValor properties: cobrancaItemBoletoId: type: string maxLength: 255 description: Identificador do registro tituloId: type: string maxLength: 255 description: Identificador do título dadosGerais: type: object allOf: – #/definitions/recDadosGeraisDetalhesTituloCobrancaBoleto description: Informações gerais dadosBoleto: type: object allOf: – #/definitions/recDadosBoletoDetalhesTituloCobrancaBoleto description: Informações do boleto dadosValor: type: object allOf: – #/definitions/recDadosValorDetalhesTituloCobrancaBoleto description: Informações dos valores dadosLiquidacao: type: object allOf: – #/definitions/recDadosLiquidacaoDetalhesTituloCobrancaBoleto description: Informações da liquidação historicosTitulo: type: array items: type: object allOf: – #/definitions/recHistoricoDetalhesTituloCobrancaBoleto description: Históricos do título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportE006pai: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportE007ufs: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportE008rai: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportE001pes: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportE085pes: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportMotivoOcorrenciaBanco: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaDadosBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaItemBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaItemBoletoDescontoDataFixa: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaItemBoletoHistorico: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaItemBoletoHistoricoMotivoOcorrencia: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaItemBoletoErro: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaItemBoletoRegistro: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportCobrancaItemBoletoMensagem: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportOperacaoBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/queries/exportOperacaoItemBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/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 /boleto/actions/reenviarCobrancaBoleto: post: description: Reenviar boleto para nova tentativa de geração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cobrancaItemBoletoId properties: cobrancaItemBoletoId: type: string maxLength: 255 description: Identificador do registro responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/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 /boleto/actions/importE006pai: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importE007ufs: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importE008rai: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importE001pes: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importE085pes: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importMotivoOcorrenciaBanco: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaDadosBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaItemBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaItemBoletoDescontoDataFixa: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaItemBoletoHistorico: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaItemBoletoHistoricoMotivoOcorrencia: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaItemBoletoErro: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaItemBoletoRegistro: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importCobrancaItemBoletoMensagem: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importOperacaoBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/actions/importOperacaoItemBoleto: 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 maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/signals/realizarIntegracoesFoundation: post: description: Primitiva responsável pela criação das entidades externas do fluxo de registro de cobrança boleto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – banco – beneficiario – titulos properties: banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco do recebimento beneficiario: type: object allOf: – #/definitions/recBeneficiario description: Dados bancários do recebimento titulos: type: array items: type: object allOf: – #/definitions/recTituloProcessoExternoRegistroCobranca minimum: 1 description: Lista de títulos que serão registrados as cobranças responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/registrarCobrancaBoletoAsync: post: description: API responsável pela criação do registro de cobrança assíncrona de boleto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId – banco – beneficiario – titulos properties: loteId: type: string maxLength: 255 description: Identificador do lote que pertence ao processoId banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco do recebimento beneficiario: type: object allOf: – #/definitions/recBeneficiario description: Dados do beneficiário titulos: type: array items: type: object allOf: – #/definitions/recTituloRegistroCobrancaAsync minimum: 1 description: Lista de títulos que serão registrados as cobranças responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/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 maxLength: 255 description: Identificador do lote de processamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/finalizarCobranca: post: description: Signal responsável pela finalização da etapa inicial da cobrança tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId properties: loteId: type: string maxLength: 255 description: Identificador do lote de processamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/retornoEnvioCobranca: post: description: Signal responsável pelo retorno de confirmação do envio da cobrança para o banco tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cobrancas properties: cobrancas: type: array items: type: object allOf: – #/definitions/recRetornoEnvioCobranca minimum: 1 description: Lista de cobranças responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/retornoConfirmacaoCobranca: post: description: Signal responsável pela confirmação do banco referente às cobranças enviadas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cobrancas properties: cobrancas: type: array items: type: object allOf: – #/definitions/recRetornoConfirmacaoCobranca minimum: 1 description: Lista de cobranças responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/retornoPagamentoCobranca: post: description: Signal responsável pela confirmação de pagamento das cobranças tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cobrancas properties: cobrancas: type: array items: type: object allOf: – #/definitions/recRetornoConfirmacaoPagamento minimum: 1 description: Lista de cobranças responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/executarOperacaoBtg: post: description: Primitiva responsável por realizar a chamada de operações para o parceiro BTG tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – operacoes – processId properties: operacoes: type: array items: type: object allOf: – #/definitions/operacaoItemBoleto minimum: 1 description: Lista de operações processId: type: string maxLength: 255 description: Id do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/registrarOperacaoBoletoAsync: post: description: Primitiva assíncrona responsável por executar o processamento de operações nos registros de cobrança Boleto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – tipoOperacao – idsTitulos properties: processId: type: string maxLength: 255 description: Id do processo tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Operação a ser executada idsTitulos: type: array items: type: string maxLength: 255 minimum: 1 description: Lista de identificadores dos títulos a serem processados novaDataVencimento: type: string format: date description: Nova data de vencimento protesto: type: object allOf: – #/definitions/recProtesto description: Protesto novoValor: type: string description: Novo valor minimum: 0 juros: type: object allOf: – #/definitions/recRegraCalculoJuros description: Juros multa: type: object allOf: – #/definitions/recRegraCalculoValor description: Multa desconto: type: object allOf: – #/definitions/recRegraCalculoDesconto description: Desconto responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/executarOperacaoESales: post: description: Primitiva responsável por realizar a chamada de operações para o parceiro eSales tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – operacoes properties: operacoes: type: array items: type: object allOf: – #/definitions/operacaoItemBoleto minimum: 1 description: Lista de operações responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/finalizarOperacao: post: description: Primitiva responsável por finalizar o processo de operações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: string maxLength: 255 description: Id do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/signals/retornoOperacoes: post: description: Primitiva responsável por finalizar o processo de operações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cobrancas properties: cobrancas: type: array items: type: object allOf: – #/definitions/recRetornoOperacao minimum: 1 description: Lista de cobranças responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /boleto/events/operationSent: post: description: Evento disparado quando o envio das operações das cobranças para a eSales foi finalizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – accountsReceivable properties: processId: type: string maxLength: 255 description: Identificador do processo accountsReceivable: type: array items: type: object allOf: – #/definitions/accountReceivableOperation minimum: 1 description: Lista de títulos enviados para processamento de operações responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /boleto/events/operationFinished: post: description: Evento disparado no final do processo de operações de cobrança Boleto x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – accountsReceivable properties: processId: type: string maxLength: 255 description: Identificador do processo accountsReceivable: type: array items: type: object allOf: – #/definitions/accountReceivableOperation minimum: 1 description: Lista de títulos enviados para processamento de operações responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /boleto/events/iniciarIntegracaoOperacaoBoletoESales: post: description: Evento disparado para comunicação com a eSales x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – operacao – txid – dataVencimento properties: operacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo de operação a ser processada txid: type: string maxLength: 255 description: Identificador do titulo dataVencimento: type: string maxLength: 255 description: Nova data vencimento protesto: type: object allOf: – #/definitions/recProtesto description: Protesto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /boleto/events/iniciarIntegracaoCobrancaBoletoESales: post: description: Evento responsável pela chamada da integração com o parceiro eSales x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – tipo – instituicaoFinanceira – recebedor – cobrancas properties: tipo: type: string maxLength: 255 description: Tipo de cobrança instituicaoFinanceira: type: object allOf: – #/definitions/recInstituicaoFinanceiraESales description: Instituição financeira que será gerado a cobrança de recebimento recebedor: type: object allOf: – #/definitions/recRecebedorESales description: Informações do recebedor da cobrança loteId: type: string maxLength: 255 description: Identificador do lote cobrancas: type: array items: type: object allOf: – #/definitions/recCobrancaESales minimum: 1 description: Títulos de cobrança responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /boleto/events/bankSlipCreated: post: description: Evento público responsável pela retorno da criação do boleto para a cobrança x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountsReceivable properties: accountsReceivable: type: array items: type: object allOf: – #/definitions/recAccountsReceivableCreated minimum: 1 description: Lista de cobranças responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /boleto/events/bankSlipReceived: post: description: Evento público responsável pela retorno do pagamento do boleto x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountsReceivable properties: accountsReceivable: type: array items: type: object allOf: – #/definitions/recAccountsReceivablePaydOff minimum: 1 description: Lista de cobranças responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /boleto/events/importE006paiEvent: 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 /boleto/events/exportE006paiEvent: 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 /boleto/events/importE007ufsEvent: 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 /boleto/events/exportE007ufsEvent: 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 /boleto/events/importE008raiEvent: 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 /boleto/events/exportE008raiEvent: 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 /boleto/events/importE001pesEvent: 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 /boleto/events/exportE001pesEvent: 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 /boleto/events/importE085pesEvent: 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 /boleto/events/exportE085pesEvent: 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 /boleto/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 /boleto/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 /boleto/events/importMotivoOcorrenciaBancoEvent: 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 /boleto/events/exportMotivoOcorrenciaBancoEvent: 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 /boleto/events/importCobrancaDadosBoletoEvent: 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 /boleto/events/exportCobrancaDadosBoletoEvent: 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 /boleto/events/importCobrancaItemBoletoEvent: 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 /boleto/events/exportCobrancaItemBoletoEvent: 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 /boleto/events/importCobrancaItemBoletoDescontoDataFixaEvent: 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 /boleto/events/exportCobrancaItemBoletoDescontoDataFixaEvent: 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 /boleto/events/importCobrancaItemBoletoHistoricoEvent: 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 /boleto/events/exportCobrancaItemBoletoHistoricoEvent: 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 /boleto/events/importCobrancaItemBoletoHistoricoMotivoOcorrenciaEvent: 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 /boleto/events/exportCobrancaItemBoletoHistoricoMotivoOcorrenciaEvent: 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 /boleto/events/importCobrancaItemBoletoErroEvent: 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 /boleto/events/exportCobrancaItemBoletoErroEvent: 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 /boleto/events/importCobrancaItemBoletoRegistroEvent: 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 /boleto/events/exportCobrancaItemBoletoRegistroEvent: 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 /boleto/events/importCobrancaItemBoletoMensagemEvent: 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 /boleto/events/exportCobrancaItemBoletoMensagemEvent: 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 /boleto/events/importOperacaoBoletoEvent: 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 /boleto/events/exportOperacaoBoletoEvent: 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 /boleto/events/importOperacaoItemBoletoEvent: 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 /boleto/events/exportOperacaoItemBoletoEvent: 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 /boleto/entities/e006pai: 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: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e006pai/{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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e007ufs: 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: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e007ufs/{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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e008rai: 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: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e008rai/{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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e001pes: 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: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e001pes/{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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e085pes: 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: array items: #/definitions/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/e085pes/{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/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/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: array items: #/definitions/ocorrenciaBanco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/motivoOcorrenciaBanco: 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: array items: #/definitions/motivoOcorrenciaBanco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaDadosBoleto: 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: array items: #/definitions/cobrancaDadosBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto: 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: array items: #/definitions/cobrancaItemBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaDadosBoleto/{parentId}/titulos: 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/cobrancaItemBoleto responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoleto 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/cobrancaItemBoleto responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoleto 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: array items: #/definitions/cobrancaItemBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaDadosBoleto/{parentId}/titulos/{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/editCobrancaItemBoleto responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoleto 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/cobrancaItemBoleto responses: 200: description: Ok schema: #/definitions/cobrancaItemBoleto 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/cobrancaItemBoleto 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 /boleto/entities/cobrancaItemBoletoDescontoDataFixa: 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: array items: #/definitions/cobrancaItemBoletoDescontoDataFixa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoDescontosDataFixa: 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/cobrancaItemBoletoDescontoDataFixa responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoDescontoDataFixa 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/cobrancaItemBoletoDescontoDataFixa responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoDescontoDataFixa 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: array items: #/definitions/cobrancaItemBoletoDescontoDataFixa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoDescontosDataFixa/{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/editCobrancaItemBoletoDescontoDataFixa responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoDescontoDataFixa 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/cobrancaItemBoletoDescontoDataFixa responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoDescontoDataFixa 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/cobrancaItemBoletoDescontoDataFixa 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 /boleto/entities/cobrancaItemBoletoHistorico: 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: array items: #/definitions/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoHistoricos: 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/cobrancaItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistorico 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/cobrancaItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistorico 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: array items: #/definitions/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoHistoricos/{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/editCobrancaItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoHistorico 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/cobrancaItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoHistorico 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/cobrancaItemBoletoHistorico 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 /boleto/entities/cobrancaItemBoletoHistoricoMotivoOcorrencia: 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: array items: #/definitions/cobrancaItemBoletoHistoricoMotivoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoletoHistorico/{parentId}/cobrancaItemBoletoHistoricoMotivosOcorrencia: 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/cobrancaItemBoletoHistoricoMotivoOcorrencia responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistoricoMotivoOcorrencia 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/cobrancaItemBoletoHistoricoMotivoOcorrencia responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistoricoMotivoOcorrencia 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: array items: #/definitions/cobrancaItemBoletoHistoricoMotivoOcorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoletoHistorico/{parentId}/cobrancaItemBoletoHistoricoMotivosOcorrencia/{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/editCobrancaItemBoletoHistoricoMotivoOcorrencia responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoHistoricoMotivoOcorrencia 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/cobrancaItemBoletoHistoricoMotivoOcorrencia responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoHistoricoMotivoOcorrencia 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/cobrancaItemBoletoHistoricoMotivoOcorrencia 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 /boleto/entities/cobrancaItemBoletoErro: 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: array items: #/definitions/cobrancaItemBoletoErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoErros: 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/cobrancaItemBoletoErro responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoErro 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/cobrancaItemBoletoErro responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoErro 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: array items: #/definitions/cobrancaItemBoletoErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoErros/{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/editCobrancaItemBoletoErro responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoErro 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/cobrancaItemBoletoErro responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoErro 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/cobrancaItemBoletoErro 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 /boleto/entities/cobrancaItemBoletoRegistro: 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: array items: #/definitions/cobrancaItemBoletoRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoRegistro: 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/cobrancaItemBoletoRegistro responses: 200: description: The created resource schema: #/definitions/cobrancaItemBoletoRegistro 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/cobrancaItemBoletoRegistro responses: 200: description: The created resource schema: #/definitions/cobrancaItemBoletoRegistro 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: array items: #/definitions/cobrancaItemBoletoRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoRegistro/{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/editCobrancaItemBoletoRegistro responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoRegistro 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/cobrancaItemBoletoRegistro responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoRegistro 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/cobrancaItemBoletoRegistro 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 /boleto/entities/cobrancaItemBoletoMensagem: 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: array items: #/definitions/cobrancaItemBoletoMensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoMensagens: 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/cobrancaItemBoletoMensagem responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoMensagem 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/cobrancaItemBoletoMensagem responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoMensagem 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: array items: #/definitions/cobrancaItemBoletoMensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoMensagens/{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/editCobrancaItemBoletoMensagem responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoMensagem 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/cobrancaItemBoletoMensagem responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoMensagem 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/cobrancaItemBoletoMensagem 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 /boleto/entities/operacaoBoleto: 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: array items: #/definitions/operacaoBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/operacaoItemBoleto: 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: array items: #/definitions/operacaoItemBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/operacaoBoleto/{parentId}/titulos: 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/operacaoItemBoleto responses: 200: description: The created resources schema: type: array items: #/definitions/operacaoItemBoleto 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/operacaoItemBoleto responses: 200: description: The created resources schema: type: array items: #/definitions/operacaoItemBoleto 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: array items: #/definitions/operacaoItemBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /boleto/entities/operacaoBoleto/{parentId}/titulos/{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/editOperacaoItemBoleto responses: 200: description: Ok schema: #/definitions/editOperacaoItemBoleto 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/operacaoItemBoleto responses: 200: description: Ok schema: #/definitions/operacaoItemBoleto 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/operacaoItemBoleto 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 definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumStatus: description: Situação do serviço type: string enum: – ACTIVE – INACTIVE enumJurFis: description: Tipo de pessoa type: string enum: – VJ – VF enumIndNif: description: Tipo do número de identificação fiscal type: string enum: – V1 – V2 – V3 enumSitReg: description: Situação do registro type: string enum: – VA – VI enumBancoRecebimento: description: Enumeration dos bancos de recebimento type: string enum: – BANCO_DO_BRASIL – SANTANDER – CAIXA_ECONOMICA_FEDERAL – BRADESCO – ITAU – SICREDI – BTG_PACTUAL enumSituacaoCobrancaDados: description: Enumeration da situação do registro de cobrança dados type: string enum: – PROCESSANDO – FINALIZADO enumCarteira: description: Enumeration de carteira type: string enum: – SIMPLES – DESCONTADA – CAUCIONADA enumEspecie: description: Enumeration de espécia type: string enum: – DUPLICATA_MERCANTIL – DUPLICATA_SERVICO enumTipoCalculo: description: Enumeration do tipo de cálculo dos valores de cobrança do título type: string enum: – PERCENTUAL – VALOR_FIXO enumTipoCalculoDesconto: description: Enumeration do tipo de cálculo dos valores de desconto do título type: string enum: – VALOR_FIXO_ATE_DATA_INFORMADA – PERCENTUAL_FIXO_ATE_DATA_INFORMADA enumTipoCalculoJuros: description: Enumeration do tipo de cálculo dos valores de juros do título type: string enum: – VALOR_DIAS_CORRIDOS – PERCENTUAL_AO_DIA_DIAS_CORRIDOS enumTipoOperacao: description: Enumeration de tipos de operações boleto type: string enum: – BAIXAR – ALTERAR_DATA_VENCIMENTO – PROTESTAR – SUSTAR_PROTESTO – ALTERAR_VALOR – ALTERAR_JUROS – ALTERAR_MULTA – ALTERAR_DESCONTO – CANCELAR_BOLETO enumSituationOperation: description: Enumeration das situações da operação type: string enum: – WRITTEN_OFF – NOT_WRITTEN_OFF – CHANGED_DUE_DATE – NOT_CHANGED_DUE_DATE – PROTESTED – NOT_PROTESTED – CANCELED_PROTEST – NOT_CANCELED_PROTEST – PROCESS_WRITTEN_OFF – PROCESS_CHANGE_DUE_DATE – PROCESS_PROTEST – PROCESS_CANCEL_PROTEST – PROCESS_CHANGE_VALUE – CHANGED_VALUE – NOT_CHANGED_VALUE – PROCESS_CHANGE_INTEREST – CHANGED_INTEREST – NOT_CHANGED_INTEREST – PROCESS_CHANGE_ASSESSMENT – CHANGED_ASSESSMENT – NOT_CHANGED_ASSESSMENT – PROCESS_CHANGE_DISCOUNT – CHANGED_DISCOUNT – NOT_CHANGED_DISCOUNT – PROCESS_CANCEL_BANK_SLIP – CANCELED_BANK_SLIP – NOT_CANCELED_BANK_SLIP enumSituacaoCobrancaItem: description: Enumeration de situação da cobrança item type: string enum: – AGUARDANDO_COBRANCA – PROCESSANDO_ENVIO_COBRANCA – COBRANCA_ENVIADA – COBRANCA_COM_PROBLEMAS – COBRANCA_GERADA – COBRANCA_NEGADA – COBRANCA_PAGA – COBRANCA_INAPTA_PARA_PROCESSAMENTO – COBRANCA_INATIVADA – ERRO_INESPERADO – FALHA_NA_VALIDACAO – CANCELANDO_COBRANCA – COBRANCA_CANCELADA – ERRO_CANCELAMENTO_COBRANCA enumTipoProtesto: description: Enumeration dos tipos de protestos type: string enum: – DIAS_CORRIDOS – DIAS_UTEIS – NAO_PROTESTAR enumSituacaoCobrancaItemDetalhes: description: Enumeration de situação dos detalhes do cobrança item type: string enum: – COBRANCA_VALIDADA – PROCESSANDO_ENVIO_COBRANCA – COBRANCA_ENVIADA – COBRANCA_COM_PROBLEMAS – COBRANCA_GERADA – COBRANCA_NEGADA – COBRANCA_PAGA – FALHA_NA_VALIDACAO – PROCESSANDO_BAIXA_BOLETO – BOLETO_BAIXADO – BOLETO_NAO_BAIXADO – PROCESSANDO_ALTERACAO_VENCIMENTO – DATA_VENCIMENTO_ALTERADA – DATA_VENCIMENTO_NAO_ALTERADA – PROCESSANDO_PROTESTO – PROTESTADO – NAO_PROTESTADO – PROCESSANDO_SUSTACAO_PROTESTO – PROTESTO_SUSTADO – PROTESTO_NAO_SUSTADO – PROCESSANDO_ALTERACAO_VALOR – VALOR_ALTERADO – VALOR_NAO_ALTERADO – PROCESSANDO_ALTERACAO_JUROS – JUROS_ALTERADOS – JUROS_NAO_ALTERADOS – PROCESSANDO_ALTERACAO_MULTA – MULTA_ALTERADA – MULTA_NAO_ALTERADA – PROCESSANDO_ALTERACAO_DESCONTO – DESCONTO_ALTERADO – DESCONTO_NAO_ALTERADO – PROCESSANDO_CANCELAMENTO_BOLETO – BOLETO_CANCELADO – BOLETO_NAO_CANCELADO enumOrigemErro: description: Enumeration da origem do erro do título type: string enum: – BANKING – PARCEIRO – BANCO enumStatusCobrancaItemTela: description: Enumeration dos status do título apresentado na tela type: string enum: – PROCESSANDO – GERADO – RECUSADO – PAGO – ERRO – CANCELANDO – CANCELADO – ERRO_CANCELAMENTO enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumSituationCreated: description: Situação da cobrança type: string enum: – CREATED – NOT_CREATED enumSituacaoIntegracaoBoleto: description: Situação da integração boleto type: string enum: – EM_PROCESSAMENTO – ERRO – ATIVO – NEGADA – REMOVIDO_PELO_USUARIO_RECEBEDOR – FALHA – ATUALIZADA – CANCELADO – FALHA_CANCELAMENTO enumSituacaoOperacao: description: Enumeration da situação do operações do registro Boleto type: string enum: – PROCESSANDO – FINALIZADO enumSituacaoProcessamentoItem: description: Enumeration da situação do título de operações do registro Boleto type: string enum: – PROCESSANDO_BAIXA – PROCESSANDO_ALTERACAO_VENCIMENTO – PROCESSANDO_PROTESTO – PROCESSANDO_SUSTACAO_PROTESTO – BAIXA_FINALIZADA – ALTERACAO_VENCIMENTO_FINALIZADA – PROTESTO_FINALIZADO – SUSTACAO_PROTESTO_FINALIZADA – FALHA_PROCESSAMENTO_BAIXA – FALHA_PROCESSAMENTO_ALTERACAO_VENCIMENTO – FALHA_PROCESSAMENTO_PROTESTO – FALHA_PROCESSAMENTO_SUSTACAO_PROTESTO – BAIXA_NAO_PERMITIDA – ALTERACAO_VENCIMENTO_NAO_PERMITIDA – PROTESTO_NAO_PERMITIDO – SUSTACAO_PROTESTO_NAO_PERMITIDA – PROCESSANDO_ALTERACAO_VALOR – FALHA_PROCESSAMENTO_ALTERACAO_VALOR – ALTERACAO_VALOR_NAO_PERMITIDA – VALOR_ALTERADO – PROCESSANDO_ALTERACAO_JUROS – FALHA_PROCESSAMENTO_ALTERACAO_JUROS – ALTERACAO_JUROS_NAO_PERMITIDA – JUROS_ALTERADO – PROCESSANDO_ALTERACAO_MULTA – FALHA_PROCESSAMENTO_ALTERACAO_MULTA – ALTERACAO_MULTA_NAO_PERMITIDA – MULTA_ALTERADO – PROCESSANDO_ALTERACAO_DESCONTO – FALHA_PROCESSAMENTO_ALTERACAO_DESCONTO – ALTERACAO_DESCONTO_NAO_PERMITIDA – DESCONTO_ALTERADO – PROCESSANDO_CANCELAMENTO – FALHA_PROCESSANDO_CANCELAMENTO – CANCELAMENTO_NAO_PERMITIDO – CANCELAMENTO_FINALIZADO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recDadosGeraisDetalhesTituloCobrancaBoleto: description: Record com os dados gerais da primitiva de detalhes de cobrança boleto type: object required: – nomeBeneficiario – documentoBeneficiario – convenio – banco – numeroAgencia – numeroConta properties: nomeBeneficiario: type: string maxLength: 255 description: Nome do beneficiário documentoBeneficiario: type: string maxLength: 255 description: Documento do beneficiário convenio: type: string maxLength: 255 description: Convênio banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco 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: 15 description: Número da conta digitoConta: type: string maxLength: 2 description: Dígito da conta accountReceivableOperation: description: Record com as informações de processamento de operações do título type: object required: – id – situation properties: id: type: string maxLength: 255 description: Identificador do título situation: type: string allOf: – #/definitions/enumSituationOperation description: Situação do processamento message: type: string maxLength: 255 description: Mensagem recRetornoOperacao: description: Record com as informações do retorno de operações type: object required: – txId – status – ocorrencia properties: txId: type: string maxLength: 255 description: Identificador da cobrança status: type: string allOf: – #/definitions/enumSituacaoIntegracaoBoleto description: Situação da cobrança dataVencimento: type: string format: date description: Nova data de vencimento protesto: type: object allOf: – #/definitions/recProtesto description: Protesto ocorrencia: type: string maxLength: 255 description: Ocorrência motivoOcorrencia: type: string maxLength: 255 description: Motivo da ocorrência valor: type: string description: Valor recDadosBoletoDetalhesTituloCobrancaBoleto: description: Record com os dados de boleto da primitiva de detalhes de cobrança boleto type: object required: – numeroTitulo – tipoTitulo – dataVencimento – dataEmissao – seuNumero – carteira – especie properties: numeroTitulo: type: string maxLength: 255 description: Número do título tipoTitulo: type: string maxLength: 255 description: Tipo de titulo cliente: type: object allOf: – #/definitions/recGenerico description: Cliente dataVencimento: type: string format: date description: Data de vencimento dataEmissao: type: string format: date description: Data da emissão seuNumero: type: string maxLength: 255 description: Seu número carteira: type: string allOf: – #/definitions/enumCarteira description: Carteira especie: type: string allOf: – #/definitions/enumEspecie description: Espécie nomeAvalista: type: string maxLength: 255 description: Nome do avalista documentoAvalista: type: string maxLength: 255 description: Documento do avalista tipoProtesto: type: string allOf: – #/definitions/enumTipoProtesto description: Tipo do protesto prazoProtesto: type: integer format: int64 description: Prazo do protesto nossoNumero: type: string maxLength: 255 description: Nosso número linhaDigitavel: type: string maxLength: 255 description: Linha digitável mensagens: type: array items: type: string maxLength: 255 description: Mensagens pixCopiaECola: type: string maxLength: 255 description: Pix copia e cola recDadosValorDetalhesTituloCobrancaBoleto: description: Record com os dados de valores do título da primitiva de detalhes de cobrança boleto type: object required: – valorOriginal properties: valorOriginal: type: string description: Valor original tipoCalculoJuros: type: string allOf: – #/definitions/enumTipoCalculoJuros description: Tipo de cálculo de juros valorOuPercentualJuros: type: string description: Valor ou percentual de juros tipoCalculoMulta: type: string allOf: – #/definitions/enumTipoCalculo description: Tipo de cálculo de multa valorOuPercentualMulta: type: string description: Valor ou percentual de multa tipoCalculoAbatimento: type: string allOf: – #/definitions/enumTipoCalculo description: Tipo de cálculo de abatimento valorOuPercentualAbatimento: type: string description: Valor ou percentual de abatimento tipoCalculoDesconto: type: string allOf: – #/definitions/enumTipoCalculoDesconto description: Tipo de cálculo de desconto descontoDataFixa: type: array items: type: object allOf: – #/definitions/recValorDataFixa description: Descontos por data fixa recValorDataFixa: description: Record de descontos de acordo com uma data estabelecida type: object required: – dataLimite – valorOuPercentual properties: dataLimite: type: string format: date description: Data limite valorOuPercentual: type: string description: Valor ou percentual recDadosLiquidacaoDetalhesTituloCobrancaBoleto: description: Record com os dados de liquidação do título da primitiva de detalhes de cobrança boleto type: object properties: dataPagamento: type: string format: date description: Data do pagamento valorPago: type: string description: Valor pago valorOriginalFinal: type: string description: Valor original final valorJurosFinal: type: string description: Valor juros final valorMultaFinal: type: string description: Valor multa final valorAbatimentoFinal: type: string description: Valor abatimento final valorDescontoFinal: type: string description: Valor desconto final recHistoricoDetalhesTituloCobrancaBoleto: description: Record com os históricos do título da primitiva de detalhes de cobrança boleto type: object required: – cobrancaItemBoletoHistoricoId – situacao – descricao – dataHoraProcessamento properties: cobrancaItemBoletoHistoricoId: type: string maxLength: 255 description: Identificador do histórico situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItemDetalhes description: Situação descricao: type: string maxLength: 255 description: Descrição do histórico dataHoraProcessamento: type: string format: date-time description: Data e hora de processamento ocorrencia: type: object allOf: – #/definitions/recGenerico description: Ocorrência recValorBanco: description: Record de informações de valores por banco da cobrança boleto type: object required: – banco – quantidadeRegistroBoleto – valorAberto – valorLiquidado – valorTotal properties: banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco quantidadeRegistroBoleto: type: integer format: int64 description: Quantidade de boleto gerado valorAberto: type: string description: Valor em aberto valorLiquidado: type: string description: Valor liquidado valorTotal: type: string description: Valor total recFiltroTitulosCobrancaBoleto: description: Record do filtro de títulos de cobrança boleto type: object properties: nomeBeneficiario: type: string maxLength: 255 description: Nome do beneficiário documentoBeneficiario: type: string maxLength: 14 description: Documento do beneficiário clientesId: type: array items: type: string maxLength: 255 description: Lista de identificadores de cliente banco: type: array items: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco status: type: array items: type: string allOf: – #/definitions/enumStatusCobrancaItemTela description: Status numeroTitulo: type: string maxLength: 255 description: Título tipoTitulo: type: string maxLength: 255 description: Tipo de título convenio: type: string maxLength: 255 description: Convênio nossoNumero: type: string maxLength: 255 description: Nosso número numeroContaRecebedor: type: string maxLength: 15 description: Número da conta do recebedor 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 dataVencimentoInicial: type: string format: date description: Data de vencimento inicial dataVencimentoFinal: type: string format: date description: Data de vencimento final 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 maxLength: 255 description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recTituloCobrancaBoleto: description: Record com as informações do título de cobrança pix type: object required: – cobrancaItemBoletoId – tituloId – nomeBeneficiario – documentoBeneficiario – tipoTitulo – numeroTitulo – dataEmissao – dataVencimento – valorOriginal – banco – status properties: cobrancaItemBoletoId: type: string maxLength: 255 description: Identificador do registro de cobrança item boleto tituloId: type: string maxLength: 255 description: Identificador do título nomeBeneficiario: type: string maxLength: 255 description: Nome do beneficiário documentoBeneficiario: type: string maxLength: 255 description: Documento do beneficiário tipoTitulo: type: string maxLength: 255 description: Tipo do título numeroTitulo: type: string maxLength: 255 description: Número do título nossoNumero: type: string maxLength: 255 description: Nosso número cliente: type: object allOf: – #/definitions/recGenerico description: Dados do cliente 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 valorOriginal: type: string description: Valor original banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco status: type: string allOf: – #/definitions/enumStatusCobrancaItemTela description: Status recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id properties: id: type: string maxLength: 255 description: Identificador da entidade codigo: type: string maxLength: 255 description: Código de negócio descricao: type: string maxLength: 255 description: Descrição de negócio label: type: string maxLength: 255 description: Descrição do label recBeneficiario: description: Record de dados do beneficiário type: object required: – numeroDocumento – convenio – agencia – contaCorrente properties: nome: type: string maxLength: 255 description: Nome do beneficiário numeroDocumento: type: string maxLength: 14 description: Número do documento convenio: type: string maxLength: 20 description: Convênio 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: 15 description: Número da conta digitoContaCorrente: type: string maxLength: 2 description: Dígito da conta recTituloProcessoExternoRegistroCobranca: description: Record com as informações do título para processamento das integrações externas allOf: – #/definitions/recTituloRegistroCobranca – type: object required: – cliente properties: cliente: type: object allOf: – #/definitions/recCliente description: Dados do cliente recTituloRegistroCobranca: description: Record com as informações gerais do título para registro de cobrança discriminator: _discriminator type: object required: – tituloId – numeroTitulo – tipoTitulo – seuNumero – dataVencimento – valores – _discriminator properties: tituloId: type: string maxLength: 255 description: Identificador do título numeroTitulo: type: string maxLength: 255 description: Número do título nossoNumero: type: string maxLength: 20 description: Nosso número tipoTitulo: type: string maxLength: 255 description: Tipo do título seuNumero: type: string maxLength: 25 description: Seu número dataVencimento: type: string format: date description: Data de vencimento carteira: type: string allOf: – #/definitions/enumCarteira description: Carteira especie: type: string allOf: – #/definitions/enumEspecie description: Espécia valores: type: object allOf: – #/definitions/recValoresTitulo description: Valores do título avalista: type: object allOf: – #/definitions/recAvalista description: Avalista protesto: type: object allOf: – #/definitions/recProtesto description: Protesto mensagens: type: array items: type: string maxLength: 255 description: Mensagens gerarPixQrCode: type: boolean description: Gerar no boleto QR code para pagamento via Pix default: false _discriminator: type: string maxLength: 255 description: recCliente: description: Record de identificação do cliente type: object properties: id: type: string maxLength: 255 description: Identificador do registro na plataforma numeroDocumento: type: string maxLength: 255 description: Número do documento nome: type: string maxLength: 255 description: Nome nomeFantasia: type: string maxLength: 255 description: Nome fantasia email: type: string maxLength: 255 description: Email numeroTelefone: type: string maxLength: 255 description: Número de telefone endereco: type: object allOf: – #/definitions/recEndereco description: Endereço codPes: type: integer format: int64 description: Código recEndereco: description: Record com as informações de endereço type: object required: – rua – bairro – pais – estado – cidade – codigoPostal properties: rua: type: string maxLength: 255 description: Rua numero: type: string maxLength: 255 description: Número bairro: type: string maxLength: 255 description: Bairro pais: type: object allOf: – #/definitions/recPais description: Identificador do país estado: type: object allOf: – #/definitions/recEstado description: Identificador do estado cidade: type: object allOf: – #/definitions/recCidade description: Identificador da cidade codigoPostal: type: string maxLength: 255 description: Código postal (CEP) recPais: description: Record do país type: object properties: id: type: string maxLength: 255 description: Identificador do registro no foundation codigo: type: string maxLength: 255 description: Código recEstado: description: Record do estado type: object properties: id: type: string maxLength: 255 description: Identificador do registro no foundation codigo: type: string maxLength: 255 description: Código recCidade: description: Record da cidade type: object properties: id: type: string maxLength: 255 description: Identificador do registro no foundation codigo: type: integer format: int64 description: Código recAvalista: description: Record do avalista type: object required: – nome – numeroDocumento properties: nome: type: string maxLength: 255 description: Nome do avalista numeroDocumento: type: string maxLength: 14 description: Documento do avalista recProtesto: description: Record com as informações de protesto type: object required: – tipo properties: tipo: type: string allOf: – #/definitions/enumTipoProtesto description: Tipo de protesto prazo: type: integer format: int64 description: Prazo recValoresTitulo: description: Record de valores do título de cobrança type: object required: – original properties: original: type: string description: Valor original juros: type: object allOf: – #/definitions/recRegraCalculoJuros description: Juros multa: type: object allOf: – #/definitions/recRegraCalculoValor description: Multas abatimento: type: object allOf: – #/definitions/recRegraCalculoValor description: Abatimentos desconto: type: object allOf: – #/definitions/recRegraCalculoDesconto description: Descontos recRegraCalculoValor: description: Record das regras de cálculos dos valores type: object required: – tipoCalculo – valorOuPercentual properties: tipoCalculo: type: string allOf: – #/definitions/enumTipoCalculo description: Tipo de cálculo valorOuPercentual: type: string description: Valor ou porcentual recRegraCalculoJuros: description: Record das regras de cálculo do valor de juros type: object required: – tipoCalculo – valorOuPercentual properties: tipoCalculo: type: string allOf: – #/definitions/enumTipoCalculoJuros description: Tipo de cálculo valorOuPercentual: type: string description: Valor ou porcentual recRegraCalculoDesconto: description: Record das regras de cálculos dos descontos type: object required: – tipoCalculo – valorDataFixa properties: tipoCalculo: type: string allOf: – #/definitions/enumTipoCalculoDesconto description: Tipo de cálculo valorDataFixa: type: array items: type: object allOf: – #/definitions/recValorDataFixa minimum: 1 description: Descontos definidos de acordo com a data estabelecida recTituloRegistroCobrancaAsync: description: Record com as informações do título para registro de cobrança allOf: – #/definitions/recTituloRegistroCobranca – type: object properties: clienteId: type: string maxLength: 255 description: Identificador do cliente erro: type: object allOf: – #/definitions/recErroDetalhado description: Erro no processamento externo recErroDetalhado: description: Record com informações detalhadas do erro type: object required: – mensagem properties: mensagem: type: string maxLength: 255 description: Mensagem do erro campo: type: string maxLength: 255 description: Campo do erro recInstituicaoFinanceiraESales: description: Record da instituição financeira que será gerado a cobrança de recebimento (eSales) type: object required: – numero properties: numero: type: string maxLength: 255 description: Número da instituição financeira recRecebedorESales: description: Record das informações do recebedor da cobrança (eSales) type: object required: – cnpj – nome – convenio – agencia – conta properties: cnpj: type: string maxLength: 255 description: CNPJ nome: type: string maxLength: 255 description: Nome/Razão social convenio: type: string maxLength: 255 description: Convênio agencia: type: object allOf: – #/definitions/recNumeroDigitoBancarioESales description: Agência conta: type: object allOf: – #/definitions/recNumeroDigitoBancarioESales description: Conta recNumeroDigitoBancarioESales: description: Record com o número e dígito para informações bancárias (eSales) type: object required: – numero properties: numero: type: string maxLength: 255 description: Número digito: type: string maxLength: 2 description: Dígito recCobrancaESales: description: Record com as informações do título para cobrança (eSales) type: object required: – txid – devedor – valor – boleto properties: txid: type: string maxLength: 255 description: Identificador da transação devedor: type: object allOf: – #/definitions/recDevedorESales description: Informações do devedor calendario: type: object allOf: – #/definitions/recCalendarioESales description: Informações de controle de tempo valor: type: object allOf: – #/definitions/recValorESales description: Valores da cobrança boleto: type: object allOf: – #/definitions/recInformacoesExclusivasBoletoESales description: Informações de boleto recDevedorESales: description: Record com as informações do devedor (eSales) type: object required: – nome – logradouro – cidade – uf – cep properties: cpf: type: string maxLength: 255 description: CPF cnpj: type: string maxLength: 255 description: CNPJ nome: type: string maxLength: 255 description: Nome/Razão social logradouro: type: string maxLength: 255 description: Logradouro cidade: type: string maxLength: 255 description: Cidade uf: type: string maxLength: 255 description: UF cep: type: string maxLength: 255 description: CEP recCalendarioESales: description: Record de informações referente ao controle de tempo da cobrança (eSales) type: object required: – dataDeVencimento properties: dataDeVencimento: type: string format: date description: Data de vencimento recValorESales: description: Record com as informações de valores da cobrança (eSales) type: object required: – original properties: original: type: string maxLength: 255 description: Valor original multa: type: object allOf: – #/definitions/recCalculoMultaJurosAbatimentoESales description: Cálculo de multa juros: type: object allOf: – #/definitions/recCalculoMultaJurosAbatimentoESales description: Cálculo de juros abatimento: type: object allOf: – #/definitions/recCalculoMultaJurosAbatimentoESales description: Cálculo de abatimento desconto: type: object allOf: – #/definitions/recCalculoDescontoESales description: Cálculo de desconto recCalculoMultaJurosAbatimentoESales: description: Record com informações do cálculo de multa, juros e abatimento (eSales) type: object required: – modalidade – valorPerc properties: modalidade: type: integer format: int64 description: Modalidade valorPerc: type: string maxLength: 255 description: Valor ou percentual recCalculoDescontoESales: description: Record com informações do desconto (eSales) type: object required: – descontoDataFixa – modalidade properties: descontoDataFixa: type: array items: type: object allOf: – #/definitions/recDescontoPorDataFixaESales minimum: 1 description: Informações de cálculo de desconto por data fixa modalidade: type: integer format: int64 description: Modalidade recDescontoPorDataFixaESales: description: Record de informações de cálculo de desconto por data fixa (eSales) type: object properties: data: type: string format: date description: Data limite valorPerc: type: string maxLength: 255 description: Valor ou percentual recInformacoesExclusivasBoletoESales: description: Record com as informações exclusivas de boleto (eSales) type: object required: – dataEmissao – seuNumero – carteira – especie – aceite properties: dataEmissao: type: string format: date description: Data de emissão seuNumero: type: string maxLength: 255 description: Seu número nossoNumero: type: string maxLength: 255 description: Nosso número carteira: type: string allOf: – #/definitions/enumCarteira description: Carteira especie: type: string allOf: – #/definitions/enumEspecie description: Espécia protesto: type: object allOf: – #/definitions/recProtestoESales description: Protesto sacadorAvalista: type: object allOf: – #/definitions/recAvalistaESales description: Avalista mensagens: type: array items: type: object allOf: – #/definitions/recMensagemESales description: Mensagens aceite: type: boolean description: Aceite recProtestoESales: description: Record com as informações de protesto (eSales) type: object required: – tipo properties: tipo: type: string allOf: – #/definitions/enumTipoProtesto description: Tipo de protesto prazo: type: integer format: int64 description: Prazo recAvalistaESales: description: Record com as informações do avalista (eSales) type: object required: – nome properties: cpf: type: string maxLength: 255 description: Documento do avalista (CPF) cnpj: type: string maxLength: 255 description: Documento do avalista (CNPJ) nome: type: string maxLength: 255 description: Nome do avalista recMensagemESales: description: Record com as mensagens do boleto (eSales) type: object required: – mensagem properties: mensagem: type: string maxLength: 255 description: Mensagem recAccountsReceivableCreated: description: Record com os dados de criação do boleto type: object required: – accountReceivableId – situation properties: accountReceivableId: type: string maxLength: 255 description: Identificador do título situation: type: string allOf: – #/definitions/enumSituationCreated description: Situação da geração do boleto digitableLine: type: string maxLength: 255 description: Linha digitável ourNumber: type: string maxLength: 255 description: Nosso número occurrence: type: object allOf: – #/definitions/recOcurrence description: Ocorrência causesOccurrence: type: array items: type: object allOf: – #/definitions/recOcurrence description: Motivos da ocorrência errors: type: array items: type: object allOf: – #/definitions/recError description: Lista de erros na geração do boleto pixCopyAndPaste: type: string maxLength: 255 description: PIX Copia e Cola gerado pelo banco pixQRCode: type: string maxLength: 255 description: Pix QRCode recOcurrence: description: Record com as infomações da ocorrência type: object required: – code – description properties: code: type: string maxLength: 255 description: Código description: type: string maxLength: 255 description: Descrição recError: description: Record com informações de erro do boleto type: object required: – message properties: message: type: string maxLength: 255 description: Mensagem de erro field: type: string maxLength: 255 description: Campo do erro recAccountsReceivablePaydOff: description: Record com os dados de pagamento do boleto type: object required: – accountReceivableId – valueReceived – originalValue – rebateValue – assessmentValue – discountValue – interestValue – payDate properties: accountReceivableId: type: string maxLength: 255 description: Identificador do título valueReceived: type: string description: Valor recebido originalValue: type: string description: Valor original rebateValue: type: string description: Valor de abatimento assessmentValue: type: string description: Valor de multa discountValue: type: string description: Valor de desconto interestValue: type: string description: Valor de juros payDate: type: string format: date description: Data do recebimento occurrence: type: object allOf: – #/definitions/recOcurrence description: Ocorrência causesOccurrence: type: array items: type: object allOf: – #/definitions/recOcurrence description: Motivos da ocorrência recRetornoEnvioCobranca: description: Record de retorno dos titulos processados pelo parceiro type: object required: – txId – status properties: txId: type: string maxLength: 255 description: Identificador da cobrança status: type: string allOf: – #/definitions/enumSituacaoIntegracaoBoleto description: Situação da cobrança erros: type: array items: type: object allOf: – #/definitions/recErroBoleto description: Erro ocorrido na geração do boleto recErroBoleto: description: Erro do boleto retornado pelo parceiro type: object required: – razao – origem properties: razao: type: string maxLength: 255 description: Razão propriedade: type: string maxLength: 255 description: Propriedade origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem recRetornoConfirmacaoCobranca: description: Record com as informações da confirmação do registro da cobrança type: object required: – txId – status – ocorrencia properties: txId: type: string maxLength: 255 description: Identificador da cobrança status: type: string allOf: – #/definitions/enumSituacaoIntegracaoBoleto description: Situação da cobrança nossoNumero: type: string maxLength: 255 description: Nosso número linhaDigitavel: type: string maxLength: 255 description: Linha digitável ocorrencia: type: string maxLength: 255 description: Ocorrência motivosOcorrencia: type: array items: type: string maxLength: 255 description: Lista de motivos da ocorrências pixCopiaCola: type: string maxLength: 255 description: PIX Copia e Cola pixQRCode: type: string maxLength: 255 description: PIX QR Code recRetornoConfirmacaoPagamento: description: Dados de confirmação de pagamento do boleto type: object required: – txId – valorPago – valorOriginal – valorMulta – valorJuros – valorAbatimento – valorDesconto – dataLiquidacao – ocorrencia properties: txId: type: string maxLength: 255 description: Txid da cobrança valorPago: type: string description: Valor pago valorOriginal: type: object allOf: – #/definitions/recValor description: Valor original valorMulta: type: object allOf: – #/definitions/recValor description: Valor multa valorJuros: type: object allOf: – #/definitions/recValor description: Valor juros valorAbatimento: type: object allOf: – #/definitions/recValor description: Valor abatimento valorDesconto: type: object allOf: – #/definitions/recValor description: Valor desconto dataLiquidacao: type: string format: date description: Data da liquidação ocorrencia: type: string maxLength: 255 description: Ocorrência motivosOcorrencia: type: array items: type: string maxLength: 255 description: Lista de motivos da ocorrências recValor: description: Record com detalhamento do valor type: object required: – valor properties: valor: type: string description: Valor recFiltroGetStatusCobrancaBoleto: description: Record do filtro de status dos títulos de cobrança boleto type: object properties: tituloId: type: array items: type: string maxLength: 255 description: Lista de Identificadores dos títulos dataEnvioInicial: type: string format: date description: Data de emissão inicial dataEnvioFinal: type: string format: date description: Data de emissão final recCobrancaDadosBoleto: description: Record de dados da cobrança de boleto type: object required: – tituloId – situacao – linhaDigitavel properties: tituloId: type: string maxLength: 255 description: Identificador do título situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação do título linhaDigitavel: type: string maxLength: 255 description: Linha digitável nossoNumero: type: string maxLength: 20 description: Nosso número pixCopiaCola: type: string maxLength: 255 description: Pix copia e cola pixQRCode: type: string maxLength: 255 description: Pix QRCode valorPago: type: string description: Valor Pago valorOriginal: type: string description: Valor original valorAbatimento: type: string description: Valor abatimento valorMulta: type: string description: Valor multa valorDesconto: type: string description: Valor desconto valorJuros: type: string description: Valor juros dataLiquidacao: type: string format: date description: Data liquidação codigoOcorrencia: type: string maxLength: 255 description: Código da ocorrência descricaoOcorrencia: type: string maxLength: 255 description: Descrição da ocorrência motivosOcorrencia: type: array items: type: string maxLength: 255 description: Lista de motivos da ocorrências errors: type: array items: type: object allOf: – #/definitions/recError description: Lista de erros na geração do boleto e006pai: description: País type: object properties: id: type: string format: uuid description: Id da entidade code: type: integer format: int64 description: Código ISO do país codPai: type: string maxLength: 4 description: Código do Sped nomPai: type: string maxLength: 150 description: Nome excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 255 description: Estado de integração com a entidade externa extIntMsg: type: string maxLength: 255 description: Mensagem do resultado da integração usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e007ufs: description: Estado type: object properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 255 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 255 description: Estado de integração com a entidade externa extIntMsg: type: string maxLength: 255 description: Mensagem do resultado da integração usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e008rai: description: Cidade type: object properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 255 description: Estado de integração com a entidade externa extIntMsg: type: string maxLength: 255 description: Mensagem do resultado da integração usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e001pes: description: Pessoa type: object properties: id: type: string format: uuid description: Id da entidade codPes: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 nomPes: type: string maxLength: 100 description: Nome apePes: type: string maxLength: 80 description: Nome fantasia tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa cnpCpf: type: string maxLength: 14 description: CNPJ/CPF indNif: type: string allOf: – #/definitions/enumIndNif description: Utilização do número de identificação fiscal (NIF) numIdf: type: string maxLength: 40 description: Número de identificação fiscal (NIF) postalCode: type: string maxLength: 20 description: Código Postal endPes: type: string maxLength: 100 description: Endereço numEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento nomBai: type: string maxLength: 75 description: Bairro e006pai: type: object allOf: – #/definitions/e006pai description: Pais e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado e008rai: type: object allOf: – #/definitions/e008rai description: Cidade sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação e085pes: type: object allOf: – #/definitions/e085pes description: Cliente intNet: type: string maxLength: 500 description: E-mail fonPes: type: string maxLength: 20 description: Telefone excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 255 description: Estado de integração com a entidade externa extIntMsg: type: string maxLength: 255 description: Mensagem do resultado da integração usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: e085pes: description: Pessoa – cliente type: object properties: id: type: string format: uuid description: Id da entidade e001pes: type: object allOf: – #/definitions/e001pes description: Pessoa sitCli: type: string allOf: – #/definitions/enumSitReg description: Situação do cliente excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 255 description: Estado de integração com a entidade externa extIntMsg: type: string maxLength: 255 description: Mensagem do resultado da integração usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: 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 maxLength: 255 description: Código do banco codigo: type: string maxLength: 255 description: Código da ocorrência descricao: type: string maxLength: 255 description: Descrição da ocorrência usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: motivoOcorrenciaBanco: description: Entidade de motivo da ocorrência do banco type: object required: – codigo – descricao – ocorrencia properties: id: type: string format: uuid description: Identificador da ocorrência codigo: type: string maxLength: 255 description: Código do motivo descricao: type: string maxLength: 255 description: Descrição do motivo ocorrencia: type: object allOf: – #/definitions/ocorrenciaBanco description: Registro da entidade de ocorrência usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: cobrancaDadosBoleto: description: Entidade de dados da cobrança de boleto type: object required: – id – loteId – bancoRecebimento – documentoBeneficiario – convenio – numeroAgencia – numeroConta – situacao properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Identificador do lote bancoRecebimento: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco utilizado no recebimento nomeBeneficiario: type: string maxLength: 255 description: Nome do beneficiário documentoBeneficiario: type: string maxLength: 14 description: Documento do beneficiário convenio: type: string maxLength: 20 description: Convênio 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: 15 description: Número da conta digitoConta: type: string maxLength: 2 description: Dígito da conta situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaDados description: Situação titulos: type: array items: type: object allOf: – #/definitions/cobrancaItemBoleto description: Títulos da cobrança usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: cobrancaItemBoleto: description: Entidade de dados do título de cobrança boleto type: object required: – txid – tituloId – numeroTitulo – tipoTitulo – dataEmissao – dataVencimento – seuNumero – valorOriginal – situacao properties: id: type: string format: uuid description: Identificador do registro txid: type: string maxLength: 255 description: Identificador utilizado para comunicação com o parceiro cobrancaDadosBoleto: type: object allOf: – #/definitions/cobrancaDadosBoleto description: Cobrança de dados boleto relacionada tituloId: type: string format: uuid description: Identificador do título numeroTitulo: type: string maxLength: 255 description: Número do título nossoNumero: type: string maxLength: 20 description: Nosso número tipoTitulo: type: string maxLength: 255 description: Tipo do título clienteId: type: string format: uuid description: Identificador do cliente nomeAvalista: type: string maxLength: 255 description: Nome do avalista documentoAvalista: type: string maxLength: 14 description: Documento do avalista dataEmissao: type: string format: date description: Data de emissão dataVencimento: type: string format: date description: Data de vencimento seuNumero: type: string maxLength: 25 description: Seu número carteira: type: string allOf: – #/definitions/enumCarteira description: Carteira especie: type: string allOf: – #/definitions/enumEspecie description: Espécie valorOriginal: type: string description: Valor original do título tipoCalculoJuros: type: string allOf: – #/definitions/enumTipoCalculoJuros description: Tipo de cálculo dos juros vlrOuPercJuros: type: string description: Valor ou percentual de juros tipoCalculoMulta: type: string allOf: – #/definitions/enumTipoCalculo description: Tipo de cálculo da multa vlrOuPercMulta: type: string description: Valor ou percentual de multa tipoCalculoAbatimento: type: string allOf: – #/definitions/enumTipoCalculo description: Tipo de cálculo do abatimento vlrOuPercAbatimento: type: string description: Valor ou percentual de abatimento tipoCalculoDesconto: type: string allOf: – #/definitions/enumTipoCalculoDesconto description: Tipo de cálculo do desconto situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação do título tipoProtesto: type: string allOf: – #/definitions/enumTipoProtesto description: Tipo de protesto prazoProtesto: type: integer format: int64 description: Prazo do protesto cobrancaItemBoletoDescontosDataFixa: type: array items: type: object allOf: – #/definitions/cobrancaItemBoletoDescontoDataFixa description: Parametrização de desconto por data fixa cobrancaItemBoletoHistoricos: type: array items: type: object allOf: – #/definitions/cobrancaItemBoletoHistorico description: Histórico de atualizações da situação do título cobrancaItemBoletoErros: type: array items: type: object allOf: – #/definitions/cobrancaItemBoletoErro description: Erros causados por cobrança cobrancaItemBoletoRegistro: type: object allOf: – #/definitions/cobrancaItemBoletoRegistro description: Registros da cobrança de boleto cobrancaItemBoletoMensagens: type: array items: type: object allOf: – #/definitions/cobrancaItemBoletoMensagem description: Mensagens bolepix: type: boolean description: Boleto contém informações de Pix default: false usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoleto: type: object required: – id allOf: – #/definitions/cobrancaItemBoleto cobrancaItemBoletoDescontoDataFixa: description: Entidade de controle dos descontos por data fixa type: object required: – dataLimite – valorOuPercentual properties: id: type: string format: uuid description: Identificador de registro cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Registro de cobrança item boleto dataLimite: type: string format: date description: Data limite do desconto valorOuPercentual: type: string description: Valor ou percentual do desconto usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoletoDescontoDataFixa: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoDescontoDataFixa cobrancaItemBoletoHistorico: description: Entidade de histórico do título de cobrança boleto type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Registro da cobrança item boleto situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItemDetalhes description: Situação mensagem: type: string maxLength: 255 description: Mensagem ocorrencia: type: object allOf: – #/definitions/ocorrenciaBanco description: Ocorrência cobrancaItemBoletoHistoricoMotivosOcorrencia: type: array items: type: object allOf: – #/definitions/cobrancaItemBoletoHistoricoMotivoOcorrencia description: Histórico de motivos da ocorrência usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoletoHistorico: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoHistorico cobrancaItemBoletoHistoricoMotivoOcorrencia: description: Entidade de histórico de motivos da ocorrência do título de cobrança boleto type: object required: – motivoOcorrencia properties: id: type: string format: uuid description: Identificador do registro cobrancaItemBoletoHistorico: type: object allOf: – #/definitions/cobrancaItemBoletoHistorico description: Registro de cobrança item boleto histórico motivoOcorrencia: type: object allOf: – #/definitions/motivoOcorrenciaBanco description: Registro do motivo da ocorrência usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoletoHistoricoMotivoOcorrencia: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoHistoricoMotivoOcorrencia cobrancaItemBoletoErro: description: Entidade de dados do título da cobrança boleto com erro type: object required: – id – motivo – origem properties: id: type: string format: uuid description: Identificador do registro cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Identificador do registro pai campo: type: string maxLength: 255 description: Campo do erro motivo: type: string maxLength: 255 description: Motivo origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoletoErro: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoErro cobrancaItemBoletoRegistro: description: Entidade com os dados do boleto do título de cobrança type: object required: – linhaDigitavel properties: id: type: string format: uuid description: Identificador do registro cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Registro da cobrança item boleto linhaDigitavel: type: string maxLength: 255 description: Linha digitável dataLiquidacao: type: string format: date description: Data liquidação valorPago: type: string description: Valor Pago valorOriginalFinal: type: string description: Valor original valorMultaFinal: type: string description: Valor multa valorJurosFinal: type: string description: Valor juros valorAbatimentoFinal: type: string description: Valor abatimento valorDescontoFinal: type: string description: Valor desconto pixCopiaCola: type: string maxLength: 255 description: Pix copia e cola pixQRCode: type: string maxLength: 255 description: Pix copia e cola usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoletoRegistro: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoRegistro cobrancaItemBoletoMensagem: description: Entidade que armazena as mensagens do boleto type: object required: – id – mensagem properties: id: type: string format: uuid description: Identificador do registro cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Identificador do registro pai mensagem: type: string maxLength: 255 description: Mensagem usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoletoMensagem: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoMensagem operacaoBoleto: description: Entidade responsável por armazenar as informações de operações de registro Boleto type: object required: – processoId – situacao properties: id: type: string format: uuid description: Identificador do registro processoId: type: string maxLength: 255 description: Identificador do processo (utilizado pelo ERP externo) situacao: type: string allOf: – #/definitions/enumSituacaoOperacao description: Situação titulos: type: array items: type: object allOf: – #/definitions/operacaoItemBoleto description: Títulos do operações usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: operacaoItemBoleto: description: Entidade responsável por armazenar as informações do título de operações do registro Boleto type: object properties: id: type: string format: uuid description: Identificador do registro operacaoBoleto: type: object allOf: – #/definitions/operacaoBoleto description: operações boleto relacionado cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Cobrança item boleto vinculado ao título que será processado situacao: type: string allOf: – #/definitions/enumSituacaoProcessamentoItem description: Situação tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Operação a ser processada novaDataVencimento: type: string format: date description: Nova data de vencimento tipoProtesto: type: string allOf: – #/definitions/enumTipoProtesto description: Tipo protesto prazoProtesto: type: integer format: int64 description: Prazo protesto minimum: 0 mensagem: type: string maxLength: 255 description: Mensagem novoValor: type: string description: Novo valor do boleto tipoCalculoJuros: type: string allOf: – #/definitions/enumTipoCalculoJuros description: Tipo de cálculo dos juros vlrOuPercJuros: type: string description: Valor ou percentual de juros tipoCalculoMulta: type: string allOf: – #/definitions/enumTipoCalculo description: Tipo de cálculo da multa vlrOuPercMulta: type: string description: Valor ou percentual de multa tipoCalculoDesconto: type: string allOf: – #/definitions/enumTipoCalculoDesconto description: Tipo de cálculo do desconto dataLimiteDesconto: type: string format: date description: Data limite do desconto vlrOuPercDesconto: type: string description: Valor ou percentual do desconto usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editOperacaoItemBoleto: type: object required: – id allOf: – #/definitions/operacaoItemBoleto 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 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 maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 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 maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 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 maxLength: 255 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 maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 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 maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 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 maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE