pix

2.0info: 3.0.0 pix description: Serviço de cobranças via PIX x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: pix 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: /pix/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 /pix/queries/getStatusCobrancaPix: post: description: Query de listagem do status dos títulos de cobrança PIX tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filtro: type: object allOf: – #/definitions/recFiltroGetStatusCobrancaPix description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – cobrancaDadosPix properties: cobrancaDadosPix: type: array items: type: object allOf: – #/definitions/recCobrancaDadosPix minimum: 1 description: Dados da cobrança Pix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/listTitulosCobrancaPix: post: description: Query de listagem dos títulos de cobrança pix tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro – pageRequest properties: filtro: type: object allOf: – #/definitions/recFiltroTitulosCobrancaPix 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/recTituloCobrancaPix 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 /pix/queries/getAcompanhamentoCobrancaPix: post: description: Query responsável pelas informações de acompanhamento da cobrança pix tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtro properties: filtro: type: object allOf: – #/definitions/recFiltroTitulosCobrancaPix description: Filtro responses: 200: description: Ok schema: type: object required: – quantidadeTotalRegistroPix – valorTotal – valorTotalAberto – valorTotalLiquidado properties: quantidadeTotalRegistroPix: type: integer format: int64 description: Quantidade de pix 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 /pix/queries/getDetalhesTituloCobrancaPix: post: description: Query responsável por retornar todas as informações relacionadas a um título de cobrança pix tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cobrancaItemPixId properties: cobrancaItemPixId: type: string description: Identificador do registro responses: 200: description: Ok schema: type: object required: – cobrancaItemPixId – tituloId – dadosGerais – dadosPix – dadosValor properties: cobrancaItemPixId: type: string description: Identificador do registro tituloId: type: string description: Identificador do título dadosGerais: type: object allOf: – #/definitions/recDadosGeraisDetalhesTituloCobrancaPix description: Informações gerais dadosPix: type: object allOf: – #/definitions/recDadosPixDetalhesTituloCobrancaPix description: Informações do pix dadosValor: type: object allOf: – #/definitions/recDadosValorDetalhesTituloCobrancaPix description: Informações dos valores historicosTitulo: type: array items: type: object allOf: – #/definitions/recHistoricoDetalhesTituloCobrancaPix 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 pix tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cobrancaItemPixId description: Identificador do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – cobrancaItemPixId – tituloId – dadosGerais – dadosPix – dadosValor properties: cobrancaItemPixId: type: string description: Identificador do registro tituloId: type: string description: Identificador do título dadosGerais: type: object allOf: – #/definitions/recDadosGeraisDetalhesTituloCobrancaPix description: Informações gerais dadosPix: type: object allOf: – #/definitions/recDadosPixDetalhesTituloCobrancaPix description: Informações do pix dadosValor: type: object allOf: – #/definitions/recDadosValorDetalhesTituloCobrancaPix description: Informações dos valores historicosTitulo: type: array items: type: object allOf: – #/definitions/recHistoricoDetalhesTituloCobrancaPix description: Históricos do título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportCobrancaDadosPix: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportCobrancaItemPix: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportCobrancaItemPixErro: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportCobrancaItemPixHistorico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportInformacoesAdicionaisPix: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportDescontoDataFixa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportCobrancaItemPixRegistro: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportCancelamentoPix: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/queries/exportCancelamentoItemPix: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 /pix/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/downloadRelatorioPagamentoPix: post: description: Action responsável por realizar o download do relatório de pagamento do Pix tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cobrancaItemPixId properties: cobrancaItemPixId: type: string description: Identificador do registro cobrancaItemPix responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importCobrancaDadosPix: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importCobrancaItemPix: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importCobrancaItemPixErro: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importCobrancaItemPixHistorico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importInformacoesAdicionaisPix: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importDescontoDataFixa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importCobrancaItemPixRegistro: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importCancelamentoPix: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/actions/importCancelamentoItemPix: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/signals/registrarCobrancaPixAsync: post: description: API responsável pela criação do registro de cobrança assíncrona de PIX copia e cola tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId – loteId – banco – filialId – dadosBancarios – titulos properties: processoId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cobrança) loteId: type: string description: Identificador do lote que pertence ao processoId banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco do recebimento filialId: type: string description: Identificador da filial dadosBancarios: type: object allOf: – #/definitions/recDadosBancarios description: Dados bancários do recebimento 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 /pix/signals/executarIntegracaoParceiro: post: description: Signal responsável pela chamada do parceiro bancário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId properties: loteId: type: string description: Identificador do lote de processamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/signals/finalizarCobranca: post: description: Signal responsável pela chamada do parceiro bancário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId properties: loteId: type: string description: Identificador do lote de processamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/signals/retornoCobrancaGerada: post: description: API responsável pelo retorno do registro de cobrança assincrona dos parceiros tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId – retornoCobranca properties: loteId: type: string description: Identificador do lote retornoCobranca: type: array items: type: object allOf: – #/definitions/recRetornoCobranca minimum: 1 description: Lista de Titutlos retornados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/signals/retornoCobrancaPaga: post: description: Signal responsável pelo retorno de confirmação de pagamento do parceiro bancário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pagamentos properties: pagamentos: type: array items: type: object allOf: – #/definitions/recConfirmacaoPagamento minimum: 1 description: Lista de pagamentos recebidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/signals/realizarIntegracoesExternas: post: description: Primitiva responsável pela criação das entidades externas do fluxo de registro de cobrança pix tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId – banco – filialId – dadosBancarios – titulos properties: processoId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cobrança) banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco do recebimento filialId: type: string description: Identificador da filial dadosBancarios: type: object allOf: – #/definitions/recDadosBancarios 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 /pix/signals/cancelarCobrancaPixAsync: post: description: Primitiva assíncrona responsável por executar o cancelamento dos registros de cobrança PIX tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processoId – titulosId properties: processoId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cancelamento) titulosId: type: array items: type: string minimum: 1 description: Lista de identificadores dos títulos a serem cancelados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/signals/finalizarCancelamento: post: description: Primitiva responsável por finalizar o processo de cancelamento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cancelamentoId properties: cancelamentoId: type: string description: Identificador do cancelamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/signals/executarCancelamentoESales: post: description: Primitiva responsável por realizar a chamada de cancelamento para o parceiro eSales tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cancelamentoId – cobrancaItemPixId – txid properties: cancelamentoId: type: string description: Identificador do cancelamento cobrancaItemPixId: type: string description: Identificador do registro de cobrança item pix txid: type: string description: Identificador do pix gerado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/signals/gerarRelatorioPagamentoPix: post: description: Signal responsável por gerar o relatório para títulos com forma de pagamento pix tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cobrancaItemPixId – situacaoReportTicket – recebedorImagemLogo properties: cobrancaItemPixId: type: string description: Identificador do título situacaoReportTicket: type: string allOf: – #/definitions/enumSituacaoReportTicketCobrancaPix description: Situação do report ticket recebedorImagemLogo: type: string description: Imagem logo do recebedor do pix responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /pix/events/iniciarIntegracaoESales: 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 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 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 /pix/events/pixCreated: post: description: API responsável pela retorno da criação do pix para a cobrança x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – accountsReceivable properties: processId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cobrança) accountsReceivable: type: array items: type: object allOf: – #/definitions/accountsReceivableReturn minimum: 1 description: Lista de títulos que serão registrados as cobranças responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pix/events/pixReceived: post: description: Evento responsável por avisar quando um pix gerado foi pago pelo fornecedor x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountsPaidOff properties: accountsPaidOff: type: array items: type: object allOf: – #/definitions/recAccountPaidOff minimum: 1 description: Lista de títulos que foram pagos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pix/events/pixCanceled: post: description: Evento disparado no final do processo de cancelamento de cobrança PIX x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – accountsReceivable properties: processId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cancelamento) accountsReceivable: type: array items: type: object allOf: – #/definitions/accountReceivableCanceled minimum: 1 description: Lista de títulos enviados para cancelamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pix/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 /pix/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 /pix/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 /pix/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 /pix/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 /pix/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 /pix/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pix/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pix/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pix/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pix/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 /pix/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 /pix/events/importCobrancaDadosPixEvent: 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 /pix/events/exportCobrancaDadosPixEvent: 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 /pix/events/importCobrancaItemPixEvent: 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 /pix/events/exportCobrancaItemPixEvent: 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 /pix/events/importCobrancaItemPixErroEvent: 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 /pix/events/exportCobrancaItemPixErroEvent: 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 /pix/events/importCobrancaItemPixHistoricoEvent: 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 /pix/events/exportCobrancaItemPixHistoricoEvent: 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 /pix/events/importInformacoesAdicionaisPixEvent: 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 /pix/events/exportInformacoesAdicionaisPixEvent: 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 /pix/events/importDescontoDataFixaEvent: 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 /pix/events/exportDescontoDataFixaEvent: 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 /pix/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 /pix/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 /pix/events/importCobrancaItemPixRegistroEvent: 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 /pix/events/exportCobrancaItemPixRegistroEvent: 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 /pix/events/importCancelamentoPixEvent: 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 /pix/events/exportCancelamentoPixEvent: 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 /pix/events/importCancelamentoItemPixEvent: 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 /pix/events/exportCancelamentoItemPixEvent: 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 /pix/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 /pix/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 /pix/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 /pix/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 /pix/entities/cobrancaDadosPix: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaDadosPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaDadosPix/{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/cobrancaItemPix responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPix 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/cobrancaItemPix responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaDadosPix/{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/editCobrancaItemPix responses: 200: description: Ok schema: #/definitions/editCobrancaItemPix 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/cobrancaItemPix responses: 200: description: Ok schema: #/definitions/cobrancaItemPix 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/cobrancaItemPix 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 /pix/entities/cobrancaItemPixErro: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPixErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/erros: 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/cobrancaItemPixErro responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPixErro 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/cobrancaItemPixErro responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPixErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPixErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/erros/{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/editCobrancaItemPixErro responses: 200: description: Ok schema: #/definitions/editCobrancaItemPixErro 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/cobrancaItemPixErro responses: 200: description: Ok schema: #/definitions/cobrancaItemPixErro 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/cobrancaItemPixErro 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 /pix/entities/cobrancaItemPixHistorico: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPixHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/cobrancaItemPixHistoricos: 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/cobrancaItemPixHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPixHistorico 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/cobrancaItemPixHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemPixHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPixHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/cobrancaItemPixHistoricos/{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/editCobrancaItemPixHistorico responses: 200: description: Ok schema: #/definitions/editCobrancaItemPixHistorico 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/cobrancaItemPixHistorico responses: 200: description: Ok schema: #/definitions/cobrancaItemPixHistorico 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/cobrancaItemPixHistorico 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 /pix/entities/informacoesAdicionaisPix: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/informacoesAdicionaisPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/informacoesAdicionais: 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/informacoesAdicionaisPix responses: 200: description: The created resources schema: type: array items: #/definitions/informacoesAdicionaisPix 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/informacoesAdicionaisPix responses: 200: description: The created resources schema: type: array items: #/definitions/informacoesAdicionaisPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/informacoesAdicionaisPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/informacoesAdicionais/{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/editInformacoesAdicionaisPix responses: 200: description: Ok schema: #/definitions/editInformacoesAdicionaisPix 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/informacoesAdicionaisPix responses: 200: description: Ok schema: #/definitions/informacoesAdicionaisPix 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/informacoesAdicionaisPix 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 /pix/entities/descontoDataFixa: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/descontoDataFixa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/descontoDataFixa: 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/descontoDataFixa responses: 200: description: The created resources schema: type: array items: #/definitions/descontoDataFixa 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/descontoDataFixa responses: 200: description: The created resources schema: type: array items: #/definitions/descontoDataFixa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/descontoDataFixa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/descontoDataFixa/{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/editDescontoDataFixa responses: 200: description: Ok schema: #/definitions/editDescontoDataFixa 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/descontoDataFixa responses: 200: description: Ok schema: #/definitions/descontoDataFixa 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/descontoDataFixa 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 /pix/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/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 /pix/entities/cobrancaItemPixRegistro: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPixRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/cobrancaItemPixRegistro: 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/cobrancaItemPixRegistro responses: 200: description: The created resource schema: #/definitions/cobrancaItemPixRegistro 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/cobrancaItemPixRegistro responses: 200: description: The created resource schema: #/definitions/cobrancaItemPixRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cobrancaItemPixRegistro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cobrancaItemPix/{parentId}/cobrancaItemPixRegistro/{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/editCobrancaItemPixRegistro responses: 200: description: Ok schema: #/definitions/editCobrancaItemPixRegistro 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/cobrancaItemPixRegistro responses: 200: description: Ok schema: #/definitions/cobrancaItemPixRegistro 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/cobrancaItemPixRegistro 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 /pix/entities/cancelamentoPix: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cancelamentoPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cancelamentoItemPix: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cancelamentoItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cancelamentoPix/{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/cancelamentoItemPix responses: 200: description: The created resources schema: type: array items: #/definitions/cancelamentoItemPix 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/cancelamentoItemPix responses: 200: description: The created resources schema: type: array items: #/definitions/cancelamentoItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/cancelamentoItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pix/entities/cancelamentoPix/{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/editCancelamentoItemPix responses: 200: description: Ok schema: #/definitions/editCancelamentoItemPix 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/cancelamentoItemPix responses: 200: description: Ok schema: #/definitions/cancelamentoItemPix 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/cancelamentoItemPix 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: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumTipEmp: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 description: Tipo de empresa: * `V1` – Indústria * `V2` – Comércio * `V3` – Distribuidor * `V4` – Transportador-Revendedor-Retalhista (TRR) * `V5` – Extração mineral/outros * `V6` – Indústria/Transporte * `V7` – Produtor rural * `V8` – Prestador de serviço * `V9` – Atividade financeira * `V10` – Atividade imobiliária * `V11` – Cooperativa * `V12` – Sociedades seguradoras de capitalização ou entidade aberta de previdência complementar * `V13` – Distribuidor de energia elétrica * `V14` – Prestador de serviço de comunicação * `V99` – Outros enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumIndNif: type: string enum: – V1 – V2 – V3 description: Tipo do número de identificação fiscal: * `V1` – Beneficiário com NIF * `V2` – Beneficiário dispensado do NIF * `V3` – País não exige NIF enumSitReg: type: string enum: – VA – VI description: Situação do registro: * `VA` – Ativo * `VI` – Inativo enumSituacaoCobrancaDados: type: string enum: – PROCESSANDO – FINALIZADO description: Enumeration da situação do registro de cobrança dados: * `PROCESSANDO` – Processando * `FINALIZADO` – Finalizado enumBancoRecebimento: type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO – ABC – BV description: Enumeration dos bancos de recebimento: * `ITAU` – Itaú – 341 * `SANTANDER` – Santander – 033 * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `BRADESCO` – Bradesco – 237 * `ABC` – ABC – 246 * `BV` – BV – 655 enumSituacaoCobrancaItem: type: string enum: – AGUARDANDO_COBRANCA – PROCESSANDO_COBRANCA – PROCESSANDO_CANCELAMENTO – FALHA_NA_VALIDACAO – COBRANCA_GERADA – COBRANCA_PAGA – COBRANCA_COM_PROBLEMAS – COBRANCA_CANCELADA – COBRANCA_INAPTA_PARA_PROCESSAMENTO – ERRO_INESPERADO – COBRANCA_INATIVADA description: Enumeration de situação da cobrança item: * `AGUARDANDO_COBRANCA` – Aguardando cobrança * `PROCESSANDO_COBRANCA` – Processando cobrança * `PROCESSANDO_CANCELAMENTO` – Processando cancelamento * `FALHA_NA_VALIDACAO` – Falha na validação * `COBRANCA_GERADA` – Cobrança gerada * `COBRANCA_PAGA` – Cobrança paga * `COBRANCA_COM_PROBLEMAS` – Cobrança com problemas * `COBRANCA_CANCELADA` – Cobrança cancelada * `COBRANCA_INAPTA_PARA_PROCESSAMENTO` – Cobrança inapta para processamento * `ERRO_INESPERADO` – Erro inesperado * `COBRANCA_INATIVADA` – Cobrança inativada enumSituacaoCobrancaItemDetalhes: type: string enum: – FALHA_NA_VALIDACAO – COBRANCA_VALIDADA – PROCESSANDO_COBRANCA – PROCESSANDO_CANCELAMENTO – COBRANCA_GERADA – COBRANCA_PAGA – COBRANCA_COM_PROBLEMAS – COBRANCA_CANCELADA – FALHA_NO_CANCELAMENTO – CANCELAMENTO_NAO_PERMITIDO description: Enumeration de situação dos detalhes do cobrança item: * `FALHA_NA_VALIDACAO` – Falha na validação * `COBRANCA_VALIDADA` – Cobrança validada * `PROCESSANDO_COBRANCA` – Processando cobrança * `PROCESSANDO_CANCELAMENTO` – Processando cancelamento * `COBRANCA_GERADA` – Cobrança gerada * `COBRANCA_PAGA` – Cobrança paga * `COBRANCA_COM_PROBLEMAS` – Cobrança com problemas * `COBRANCA_CANCELADA` – Cobrança cancelada * `FALHA_NO_CANCELAMENTO` – Falha no cancelamento * `CANCELAMENTO_NAO_PERMITIDO` – Cancelamento não permitido enumTipoCalculo: type: string enum: – PERCENTUAL – VALOR_FIXO description: Enumeration do tipo de cálculo dos valores de cobrança do título: * `PERCENTUAL` – Percentual * `VALOR_FIXO` – Valor fixo enumTipoCalculoDesconto: type: string enum: – VALOR_FIXO_ATE_DATA_INFORMADA – PERCENTUAL_FIXO_ATE_DATA_INFORMADA – VALOR_POR_ANTECIPACAO_DIA_CORRIDO – VALOR_POR_ANTECIPACAO_DIA_UTIL – PERCENTUAL_POR_ANTECIPACAO_DIA_CORRIDO – PERCENTUAL_POR_ANTECIPACAO_DIA_UTIL description: Enumeration do tipo de cálculo dos valores de desconto do título: * `VALOR_FIXO_ATE_DATA_INFORMADA` – Valor fixo até a(s) data(s) informada(s) * `PERCENTUAL_FIXO_ATE_DATA_INFORMADA` – Percentual até a data informada * `VALOR_POR_ANTECIPACAO_DIA_CORRIDO` – Valor por antecipação dia corrido * `VALOR_POR_ANTECIPACAO_DIA_UTIL` – Valor por antecipação dia útil * `PERCENTUAL_POR_ANTECIPACAO_DIA_CORRIDO` – Percentual por antecipação dia corrido * `PERCENTUAL_POR_ANTECIPACAO_DIA_UTIL` – Percentual por antecipação dia útil enumTipoCalculoJuros: type: string enum: – VALOR_DIAS_CORRIDOS – PERCENTUAL_AO_DIA_DIAS_CORRIDOS – PERCENTUAL_AO_MES_DIAS_CORRIDOS – PERCENTUAL_AO_ANO_DIAS_CORRIDOS – VALOR_DIAS_UTEIS – PERCENTUAL_AO_DIA_DIAS_UTEIS – PERCENTUAL_AO_MES_DIAS_UTEIS – PERCENTUAL_AO_ANO_DIAS_UTEIS description: Enumeration do tipo de cálculo dos valores de juros do título: * `VALOR_DIAS_CORRIDOS` – Valor (dias corridos) * `PERCENTUAL_AO_DIA_DIAS_CORRIDOS` – Percentual ao dia (dias corridos) * `PERCENTUAL_AO_MES_DIAS_CORRIDOS` – Percentual ao mês (dias corridos) * `PERCENTUAL_AO_ANO_DIAS_CORRIDOS` – Percentual ao ano (dias corridos) * `VALOR_DIAS_UTEIS` – Valor (dias úteis) * `PERCENTUAL_AO_DIA_DIAS_UTEIS` – Percentual ao dia (dias úteis) * `PERCENTUAL_AO_MES_DIAS_UTEIS` – Percentual ao mês (dias úteis) * `PERCENTUAL_AO_ANO_DIAS_UTEIS` – Percentual ao ano (dias úteis) enumReceivableBank: type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO – ABC – BV description: Enumeration de bancos de recebimento: * `ITAU` – Itaú – 341 * `SANTANDER` – Santander – 033 * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `BRADESCO` – Bradesco – 237 * `ABC` – ABC – 246 * `BV` – BV – 655 enumOrigemErro: type: string enum: – BANKING – PARCEIRO – BANCO – COMUNICACAO_PARCEIRO description: Enumeration da origem do erro do título: * `BANKING` – Banking * `PARCEIRO` – Parceiro * `BANCO` – Banco * `COMUNICACAO_PARCEIRO` – Comunicação com o parceiro enumSituation: type: string enum: – CREATED – NOT_CREATED description: Situação da cobrança: * `CREATED` – Ativo * `NOT_CREATED` – Não Gerado enumSituacaoPix: type: string enum: – ATIVO – ERRO description: Situação do pix: * `ATIVO` – Ativo * `ERRO` – ERRO enumStatusRegistroCobrancaRetornoESales: type: string enum: – ATIVA – CONCLUIDA – REMOVIDO_PELO_USUARIO_RECEBEDOR – REMOVIDO_PELO_PSP description: Status do registro da cobrança do retorno da e-sales: * `ATIVA` – ATIVA * `CONCLUIDA` – CONCLUIDA * `REMOVIDO_PELO_USUARIO_RECEBEDOR` – REMOVIDO PELO USUARIO RECEBEDOR * `REMOVIDO_PELO_PSP` – REMOVIDO PELO PSP enumStatusCobrancaItemTela: type: string enum: – PROCESSANDO_COBRANCA_PIX – PROCESSANDO_CANCELAMENTO – PIX_GERADO – PIX_PAGO – PIX_CANCELADO – ERRO description: Enumeration dos status do título apresentado na tela: * `PROCESSANDO_COBRANCA_PIX` – Processando cobrança pix * `PROCESSANDO_CANCELAMENTO` – Processando cancelamento * `PIX_GERADO` – Pix gerado * `PIX_PAGO` – Pix pago * `PIX_CANCELADO` – Pix cancelado * `ERRO` – Erro enumTypeOrder: type: string enum: – ASC – DESC description: Enumeração para o tipo de ordenação: * `ASC` – Tipo de ordenação – Crescente * `DESC` – Tipo de ordenação – Decrescente enumSituacaoReportTicketCobrancaPix: type: string enum: – RELATORIO_PIX_NAO_GERADO – RELATORIO_PIX_PROCESSANDO_DOWNLOAD – RELATORIO_PIX_GERADO_DOWNLOAD – ERRO_GERACAO_RELATORIO_PAGAMENTO_PIX description: Situação do report ticket: * `RELATORIO_PIX_NAO_GERADO` – Relatório pix não gerado * `RELATORIO_PIX_PROCESSANDO_DOWNLOAD` – Relatório pix processando download * `RELATORIO_PIX_GERADO_DOWNLOAD` – Relatório pix gerado download * `ERRO_GERACAO_RELATORIO_PAGAMENTO_PIX` – Relatório pix com erro na geração enumSituationCanceled: type: string enum: – CANCELED – NOT_CANCELED description: Situação do cancelamento: * `CANCELED` – Cancelado * `NOT_CANCELED` – Não cancelado enumSituacaoCancelamento: type: string enum: – PROCESSANDO – FINALIZADO description: Enumeration da situação do cancelamento do registro PIX: * `PROCESSANDO` – Processando * `FINALIZADO` – Finalizado enumSituacaoCancelamentoItem: type: string enum: – PROCESSANDO_CANCELAMENTO – CANCELADO – FALHA_NO_CANCELAMENTO – CANCELAMENTO_NAO_PERMITIDO description: Enumeration da situação do título de cancelamento do registro PIX: * `PROCESSANDO_CANCELAMENTO` – Processando cancelamento * `CANCELADO` – Cancelado * `FALHA_NO_CANCELAMENTO` – Falha no cancelamento * `CANCELAMENTO_NAO_PERMITIDO` – Cancelamento não permitido userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error recFiltroGetStatusCobrancaPix: description: Record do filtro de status dos títulos de cobrança Pix type: object properties: tituloId: type: array items: type: string description: Lista de Identificadores dos títulos dataEnvioInicial: type: string format: date description: Data de envio inicial dataEnvioFinal: type: string format: date description: Data de envio final recCobrancaDadosPix: description: Record de dados da cobrança Pix type: object required: – tituloId – situacao – valorPago – valorOriginalFinal – valorAbatimentoFinal – valorMultaFinal – valorDescontoFinal – valorJurosFinal – horarioPagamento – endToEndId properties: tituloId: type: string description: Identificador do título situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação da geração do PIX dataCriacao: type: string format: date description: Data de criação do PIX pixCopiaCola: type: string description: PIX Copia e Cola gerado pelo banco pixQRCode: type: string description: Pix QRCode errors: type: array items: type: object allOf: – #/definitions/recError description: Lista de erros na geração do PIX valorPago: type: string description: Valor recebido valorOriginalFinal: type: string description: Valor original valorAbatimentoFinal: type: string description: Valor de abatimento valorMultaFinal: type: string description: Valor de multa valorDescontoFinal: type: string description: Valor de desconto valorJurosFinal: type: string description: Valor de juros horarioPagamento: type: string format: date-time description: Data/Hora do Recebimento informacaoPagador: type: string description: Informação do pagador endToEndId: type: string description: Identificador único do pagamento recDadosGeraisDetalhesTituloCobrancaPix: description: Record com os dados gerais da primitiva de detalhes de cobrança pix type: object required: – empresa – filial – chavePix – banco – numeroAgencia – numeroConta properties: empresa: type: object allOf: – #/definitions/recGenerico description: Empresa filial: type: object allOf: – #/definitions/recGenerico description: Filial chavePix: type: string description: Chave pix banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco numeroAgencia: type: string description: Número da agência digitoAgencia: type: string maxLength: 2 description: Dígito da agência numeroConta: type: string description: Número da conta digitoConta: type: string maxLength: 2 description: Dígito da conta recDadosPixDetalhesTituloCobrancaPix: description: Record com os dados de pix da primitiva de detalhes de cobrança pix type: object required: – numeroTitulo – tipoTitulo – dataVencimento properties: numeroTitulo: type: string description: Número do título tipoTitulo: type: string description: Tipo de titulo cliente: type: object allOf: – #/definitions/recGenerico description: Cliente dataVencimento: type: string format: date description: Data de vencimento validadeAposVencimento: type: integer format: int64 description: Validade após vencimento solicitacaoPagador: type: string description: Solicitação do pagador informacoesAdicionais: type: array items: type: object allOf: – #/definitions/recInformacoesAdicionais description: Informações adicionais dataCriacao: type: string format: date description: Data de criação pixCopiaECola: type: string description: Pix copia e cola 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 dataHoraPagamento: type: string format: date-time description: Data e hora do pagamento informacaoPagador: type: string description: Informação do pagador recDadosValorDetalhesTituloCobrancaPix: description: Record com os dados de valores do título da primitiva de detalhes de cobrança pix 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 valorOuPercentualDesconto: type: string description: Valor ou percentual de desconto descontoDataFixa: type: array items: type: object allOf: – #/definitions/recValorDataFixa description: Descontos por data fixa recHistoricoDetalhesTituloCobrancaPix: description: Record com os históricos do título da primitiva de detalhes de cobrança pix type: object required: – situacao – descricao – dataHoraProcessamento properties: situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItemDetalhes description: Situação descricao: type: string description: Descrição do histórico dataHoraProcessamento: type: string format: date-time description: Data e hora de processamento recValorBanco: description: Record de informações de valores por banco da cobrança pix type: object required: – banco – quantidadeRegistroPix – valorTotalAberto – valorTotalLiquidado – valorTotal properties: banco: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco quantidadeRegistroPix: type: integer format: int64 description: Quantidade de pix gerado valorTotalAberto: type: string description: Valor total em aberto valorTotalLiquidado: type: string description: Valor total liquidado valorTotal: type: string description: Valor total recTituloCobrancaPix: description: Record com as informações do título de cobrança pix type: object required: – cobrancaItemPixId – tituloId – empresa – filial – numeroTitulo – tipoTitulo – dataEnvio – dataVencimento – valorOriginal – banco – status properties: cobrancaItemPixId: type: string description: Identificador do registro de cobrança item pix tituloId: type: string description: Identificador do título empresa: type: object allOf: – #/definitions/recGenerico description: Dados da empresa filial: type: object allOf: – #/definitions/recGenerico description: Dados da filial numeroTitulo: type: string description: Número do título tipoTitulo: type: string description: Tipo do título cliente: type: object allOf: – #/definitions/recGenerico description: Dados do cliente dataEnvio: type: string format: date description: Data de envio 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 pixCopiaECola: type: string description: Pix copia e cola recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id properties: id: type: string description: Identificador da entidade codigo: type: string description: Código de negócio descricao: type: string description: Descrição de negócio label: type: string description: Descrição do label recPageRequest: description: Record para paginação e ordenação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recFiltroTitulosCobrancaPix: description: Record do filtro de títulos de cobrança pix type: object properties: empresasId: type: array items: type: string description: Identificador da empresa filiaisId: type: array items: type: string description: Lista de identificadores de filial clientesId: type: array items: type: string description: Lista de identificadores de cliente banco: type: array items: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco chavePixRecebedor: type: string description: Chave pix do recebedor numeroContaRecebedor: type: string maxLength: 15 description: Número da conta do recebedor status: type: array items: type: string allOf: – #/definitions/enumStatusCobrancaItemTela description: Status numeroTitulo: type: string description: Título tipoTitulo: type: string description: Tipo de título dataEnvioInicial: type: string format: date description: Data de envio inicial dataEnvioFinal: type: string format: date description: Data de envio 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 checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recDadosBancarios: description: Record de dados do recebimento bancário type: object required: – chavePix – agencia – contaCorrente properties: chavePix: type: string description: Chave pix 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 recTituloRegistroCobranca: description: Record com as informações gerais do título para registro de cobrança discriminator: _discriminator type: object required: – tituloId – numeroTitulo – tipoTitulo – dataVencimento – valores – _discriminator properties: tituloId: type: string description: Identificador do título numeroTitulo: type: string description: Número do título tipoTitulo: type: string description: Tipo do título dataVencimento: type: string format: date description: Data de vencimento validadeAposVencimento: type: integer format: int64 description: Dias corridos após o vencimento que a cobrança poderá ser paga valores: type: object allOf: – #/definitions/recValoresTitulo description: Valores do título informacoesExclusivas: type: object allOf: – #/definitions/recInformacoesExclusivas description: Informações excluisivas do pix _discriminator: type: string description: 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 recTituloRegistroCobrancaAsync: description: Record com as informações do título para registro de cobrança allOf: – #/definitions/recTituloRegistroCobranca – type: object properties: clienteId: type: string description: Identificador do cliente erro: type: object allOf: – #/definitions/recErroDetalhado description: Erro no processamento externo recCliente: description: Record de identificação do cliente type: object properties: id: type: string description: Identificador do registro na plataforma numeroDocumento: type: string description: Número do documento nome: type: string description: Nome nomeFantasia: type: string description: Nome fantasia codPes: type: integer format: int64 description: Código recErroDetalhado: description: Record com informações detalhadas do erro type: object required: – mensagem properties: mensagem: type: string description: Mensagem do erro campo: type: string description: Campo do erro 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 properties: tipoCalculo: type: string allOf: – #/definitions/enumTipoCalculoDesconto description: Tipo de cálculo valorOuPercentual: type: string description: Valor ou porcentual valorDataFixa: type: array items: type: object allOf: – #/definitions/recValorDataFixa description: Descontos definidos de acordo com a data estabelecida 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 recInformacoesExclusivas: description: Record de informações exclusivas do pix type: object properties: solicitacaoPagador: type: string maxLength: 140 description: Solicitação do pagador informacoesAdicionais: type: array items: type: object allOf: – #/definitions/recInformacoesAdicionais description: Informações adicionais recInformacoesAdicionais: description: Record de informações adicionais type: object required: – nome – valor properties: nome: type: string maxLength: 50 description: Nome valor: type: string maxLength: 200 description: Valor recInstituicaoFinanceiraESales: description: Record da instituição financeira que será gerado a cobrança de recebimento (eSales) type: object required: – numero properties: numero: type: string description: Número da instituição financeira recRecebedorESales: description: Record das informações do recebedor da cobrança (eSales) type: object required: – cnpj – nome – chavePix – agencia – conta properties: cnpj: type: string description: CNPJ nome: type: string description: Nome/Razão social chavePix: type: string description: Chave PIX 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 description: Número digito: type: string description: Dígito recCobrancaESales: description: Record com as informações do título para cobrança (eSales) type: object required: – txid – devedor – valor properties: txid: type: string 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 pix: type: object allOf: – #/definitions/recInformacoesExclusivasPixESales description: Informação exclusivas para PIX recDevedorESales: description: Record com as informações do devedor (eSales) type: object required: – nome properties: cpf: type: string description: CPF cnpj: type: string description: CNPJ nome: type: string description: Nome/Razão social logradouro: type: string description: Logradouro cidade: type: string description: Cidade uf: type: string description: UF cep: type: string 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 validadeAposVencimento: type: integer format: int64 description: Validade da cobrança após vencimento recValorESales: description: Record com as informações de valores da cobrança (eSales) type: object required: – original properties: original: type: string 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 description: Valor ou percentual recCalculoDescontoESales: description: Record com informações do desconto (eSales) type: object required: – modalidade properties: descontoDataFixa: type: array items: type: object allOf: – #/definitions/recDescontoPorDataFixaESales description: Informações de cálculo de desconto por data fixa modalidade: type: integer format: int64 description: Modalidade valorPerc: type: string description: Valor ou percentual 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 description: Valor ou percentual recInformacoesExclusivasPixESales: description: Informações exclusivas PIX (eSales) type: object properties: solicitacaoPagador: type: string description: Solicitação do pagador infoAdicionais: type: array items: type: object allOf: – #/definitions/recInformacoesAdicionaisPixESales description: Informações adicionais recInformacoesAdicionaisPixESales: description: Record de informações adicionais do PIX (eSales) type: object required: – nome – valor properties: nome: type: string description: Nome valor: type: string description: Valor accountsReceivableReturn: description: Record com os dados de criação do PIX type: object required: – id – situation properties: id: type: string description: Identificador do título situation: type: string allOf: – #/definitions/enumSituation description: Situação da geração do PIX creationDate: type: string format: date description: Data de criação do PIX errors: type: array items: type: object allOf: – #/definitions/recError description: Lista de erros na geração do PIX pixCopyAndPaste: type: string description: PIX Copia e Cola gerado pelo banco pixQRCode: type: string description: Pix QRCode recError: description: Record com informações de erro pix type: object required: – message properties: message: type: string description: Mensagem de erro field: type: string description: Campo do erro recRetornoCobranca: description: Record de Retorno dos titulos processados pelo parceiro type: object required: – txId – status properties: txId: type: string description: Identificador da Cobrança dataCriacao: type: string format: date description: Data de Criação status: type: string allOf: – #/definitions/enumSituacaoPix description: Situação da Cobrança pixCopiaECola: type: string description: Pix Copia e Cola erros: type: array items: type: object allOf: – #/definitions/recErroPix description: Erro ocorrido na geração do PIX pixQRCode: type: string maxLength: 2048 description: Pix QRCode recErroPix: description: Erro do PIX retornado pelo parceiro type: object required: – razao – origem properties: razao: type: string description: Razão propriedade: type: string description: Propriedade origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem recConfirmacaoPagamento: description: Dados de confirmação de pagamento do pix type: object required: – txid – valor – valoresDetalhados – horario properties: txid: type: string description: txId da cobrança valor: type: string description: Valor Pago valoresDetalhados: type: object allOf: – #/definitions/recValoresDetalhados description: Valores detalhados horario: type: string format: date-time description: Data e Hora do pagamento infoPagador: type: string description: Informações do pagador endToEndId: type: string description: Identificador Unico do Pagamento recValoresDetalhados: description: Record com informações relacionadas ao detalhamente do valor pago no título type: object required: – original – multa – juros – abatimento – desconto properties: original: type: object allOf: – #/definitions/recValor description: Valor original multa: type: object allOf: – #/definitions/recValor description: Valor multa juros: type: object allOf: – #/definitions/recValor description: Valor juros abatimento: type: object allOf: – #/definitions/recValor description: Valor abatimento desconto: type: object allOf: – #/definitions/recValor description: Valor desconto recValor: description: Record com detalhamento do valor type: object required: – valor properties: valor: type: string description: Valor recAccountPaidOff: description: Record com as informações dos títulos recebidos type: object required: – accountReceivableId – valueReceived – originalValue – rebateValue – assessmentValue – discountValue – interestValue – payDate – endToEndId properties: accountReceivableId: type: string 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-time description: Data/Hora do Recebimento payerInformation: type: string description: Informação do pagador endToEndId: type: string description: Identificador único do pagamento accountReceivableCanceled: description: Record com as informações de cancelamento do título type: object required: – id – situation properties: id: type: string description: Identificador do título situation: type: string allOf: – #/definitions/enumSituationCanceled description: Situação do cancelamento erro: type: string description: Mensagem de erro 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 description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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 description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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 description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Fantasia tipEmp: type: string allOf: – #/definitions/enumTipEmp description: Ramo de atividade tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa numCgc: type: string maxLength: 18 description: CPF/CNPJ numIdf: type: string maxLength: 40 description: Número identificação fiscal excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cobrancaDadosPix: description: Entidade de dados da cobrança de pix type: object required: – id – loteId – processoId – bancoRecebimento – filialId – chavePix – numeroAgencia – numeroConta – situacao properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Identificador do lote processoId: type: string description: Identificador do processo (utilizado pelo ERP externo) bancoRecebimento: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco utilizado no recebimento filialId: type: string format: uuid description: Identificador da filial chavePix: type: string description: Chave pix 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/cobrancaItemPix description: Títulos da cobrança usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cobrancaItemPix: description: Entidade de dados do título da cobrança de pix type: object required: – txid – tituloId – numeroTitulo – tipoTitulo – dataVencimento – valorOriginal – situacao – situacaoReportTicket properties: id: type: string format: uuid description: Identificador do registro txid: type: string description: Identificador utilizado para comunicação com o parceiro cobrancaDadosPix: type: object allOf: – #/definitions/cobrancaDadosPix description: Cobrança de dados pix relacionada tituloId: type: string format: uuid description: Identificador do título numeroTitulo: type: string description: Número do título tipoTitulo: type: string description: Tipo do título clienteId: type: string format: uuid description: Identificador do cliente dataVencimento: type: string format: date description: Data de vencimento validateAposVencimento: type: integer format: int64 description: Validade permitida após vencimento minimum: 0 maximum: 9999 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 vlrOuPercDesconto: type: string description: Valor ou percentual de desconto descontoDataFixa: type: array items: type: object allOf: – #/definitions/descontoDataFixa description: Parametrização de desconto por data fixa situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação do título solicitacaoPagador: type: string description: Solicitação do pagador informacoesAdicionais: type: array items: type: object allOf: – #/definitions/informacoesAdicionaisPix description: Informações adicionais cobrancaItemPixHistoricos: type: array items: type: object allOf: – #/definitions/cobrancaItemPixHistorico description: Histórico de atualizações da situação do título erros: type: array items: type: object allOf: – #/definitions/cobrancaItemPixErro description: Erros causados por cobrança cobrancaItemPixRegistro: type: object allOf: – #/definitions/cobrancaItemPixRegistro description: Registros da cobrança de pix reportTicket: type: string format: uuid description: Identificador do relatório de cobrança de pix situacaoReportTicket: type: string allOf: – #/definitions/enumSituacaoReportTicketCobrancaPix description: Situação do relatório de cobrança de pix usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editCobrancaItemPix: type: object required: – id allOf: – #/definitions/cobrancaItemPix cobrancaItemPixErro: description: Entidade de dados do título da cobrança de pix com erro type: object required: – id – motivo – origem properties: id: type: string format: uuid description: Identificador do registro cobrancaItemPix: type: object allOf: – #/definitions/cobrancaItemPix description: Identificador do registro pai campo: type: string description: Campo do Erro motivo: type: string description: Motivo origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editCobrancaItemPixErro: type: object required: – id allOf: – #/definitions/cobrancaItemPixErro cobrancaItemPixHistorico: description: Entidade de histórico do título de cobrança do pix type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro cobrancaItemPix: type: object allOf: – #/definitions/cobrancaItemPix description: Registro da cobrança item pix situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItemDetalhes description: Situação mensagem: type: string description: Mensagem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editCobrancaItemPixHistorico: type: object required: – id allOf: – #/definitions/cobrancaItemPixHistorico informacoesAdicionaisPix: description: Entidade de informações adicionais do pix type: object required: – id – nome – valor properties: id: type: string format: uuid description: Identificador do registro cobrancaItemPix: type: object allOf: – #/definitions/cobrancaItemPix description: Registro de cobrança item pix nome: type: string description: Nome valor: type: string description: Valor usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editInformacoesAdicionaisPix: type: object required: – id allOf: – #/definitions/informacoesAdicionaisPix descontoDataFixa: description: Entidade de controle dos descontos por data fixa type: object required: – id – dataLimite – valorOuPercentual properties: id: type: string format: uuid description: Identificador de registro cobrancaItemPix: type: object allOf: – #/definitions/cobrancaItemPix description: Registro de cobrança item pix dataLimite: type: string format: date description: Data limite do desconto valorOuPercentual: type: string description: Valor ou percentual do desconto usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDescontoDataFixa: type: object required: – id allOf: – #/definitions/descontoDataFixa 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 description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cobrancaItemPixRegistro: description: Entidade com os dados do PIX do título de cobrança type: object required: – dataCriacao – pixCopiaCola – pixQRCode properties: id: type: string format: uuid description: Identificador do registro cobrancaItemPix: type: object allOf: – #/definitions/cobrancaItemPix description: Registro da cobrança item pix dataCriacao: type: string format: date description: Data de Criação do PIX pixCopiaCola: type: string description: PIX Copia e Cola 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 horarioPagamento: type: string format: date-time description: Horario do Pagamento informacaoPagador: type: string description: Informações do Pagador endToEndId: type: string description: Identificador único do pagamento pixQRCode: type: string format: byte description: Pix QRCode usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editCobrancaItemPixRegistro: type: object required: – id allOf: – #/definitions/cobrancaItemPixRegistro cancelamentoPix: description: Entidade responsável por armazenar as informações de cancelamento de registro PIX type: object required: – processoId – situacao properties: id: type: string format: uuid description: Identificador do registro processoId: type: string description: Identificador do processo (utilizado pelo ERP externo) situacao: type: string allOf: – #/definitions/enumSituacaoCancelamento description: Situação titulos: type: array items: type: object allOf: – #/definitions/cancelamentoItemPix description: Títulos do cancelamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cancelamentoItemPix: description: Entidade responsável por armazenar as informações do título de cancelamento do registro PIX type: object required: – situacao properties: id: type: string format: uuid description: Identificador do registro cancelamentoPix: type: object allOf: – #/definitions/cancelamentoPix description: Cancelamento pix relacionado cobrancaItemPix: type: object allOf: – #/definitions/cobrancaItemPix description: Cobrança item pix vinculado ao título que será cancelado situacao: type: string allOf: – #/definitions/enumSituacaoCancelamentoItem description: Situação mensagem: type: string description: Mensagem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editCancelamentoItemPix: type: object required: – id allOf: – #/definitions/cancelamentoItemPix notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage