cobranca

2.0info: 1.12.1 cobranca description: Serviço de fachada para o domínio de cobrança do banking x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: cobranca 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: /cobranca/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 /cobranca/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/queries/exportCobrancaDadosBoleto: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/queries/exportCobrancaItemBoleto: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/queries/exportCobrancaItemBoletoHistorico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/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 /cobranca/actions/retornoCobrancaESales: post: description: API responsável pelo retorno da criação do registros e pagamentos de cobrança assíncrona do parceiro eSales tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipo properties: tipo: type: string maxLength: 255 description: Tipo da cobrança loteId: type: string maxLength: 255 description: Identificador do lote cobrancas: type: array items: type: object allOf: – #/definitions/recCobrancaESalesRetorno description: Lista das cobranças responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/actions/retornoCobrancaBoletoBtg: post: description: API responsável pelo retorno da criação do registros de cobrança assíncrona do parceiro BTG tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – webhookId – event properties: webhookId: type: string maxLength: 255 description: ID do webhook no BTG event: type: string maxLength: 255 description: Evento publicado pelo BTG data: type: object allOf: – #/definitions/recCobrancaBtgRetorno description: Dados da cobrança responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/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 /cobranca/actions/importCobrancaDadosBoleto: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/actions/importCobrancaItemBoleto: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/actions/importCobrancaItemBoletoHistorico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/events/importCobrancaDadosBoletoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /cobranca/events/exportCobrancaDadosBoletoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /cobranca/events/importCobrancaItemBoletoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /cobranca/events/exportCobrancaItemBoletoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /cobranca/events/importCobrancaItemBoletoHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /cobranca/events/exportCobrancaItemBoletoHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /cobranca/entities/cobrancaDadosBoleto: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/cobrancaDadosBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/entities/cobrancaItemBoleto: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/cobrancaItemBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoHistoricos: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/cobrancaItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/cobrancaItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoHistoricos/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCobrancaItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cobrancaItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumStatusRegistroCobrancaRetornoESales: description: Status do registro da cobrança do retorno da eSales type: string enum: – ATIVA – CONCLUIDA – REMOVIDA_PELO_USUARIO_RECEBEDOR – REMOVIDA_PELO_PSP – EM_PROCESSAMENTO – NEGADA enumBancoRecebimento: description: Enumeration dos bancos de recebimento type: string enum: – BANCO_DO_BRASIL – SANTANDER – CAIXA_ECONOMICA_FEDERAL – BRADESCO – ITAU – SICREDI – BTG_PACTUAL enumStatusRegistroCobrancaRetornoBtg: description: Status do registro da cobrança do retorno da BTG type: string enum: – CREATED – FAILED – UPDATED – PAID – CANCELED – CANCEL_FAILED – RETURNED enumSituacaoCobrancaItem: description: Enumeration de situação da cobrança item type: string enum: – AGUARDANDO_COBRANCA – PROCESSANDO_ENVIO_COBRANCA – COBRANCA_ENVIADA – COBRANCA_COM_PROBLEMAS – COBRANCA_GERADA – COBRANCA_NEGADA – COBRANCA_PAGA – COBRANCA_INAPTA_PARA_PROCESSAMENTO – COBRANCA_INATIVADA – ERRO_INESPERADO – FALHA_NA_VALIDACAO enumTipoProtesto: description: Enumeration dos tipos de protestos type: string enum: – DIAS_CORRIDOS – DIAS_UTEIS – NAO_PROTESTAR enumSituacaoCobrancaItemDetalhes: description: Enumeration de situação dos detalhes do cobrança item type: string enum: – COBRANCA_VALIDADA – PROCESSANDO_ENVIO_COBRANCA – COBRANCA_ENVIADA – COBRANCA_COM_PROBLEMAS – COBRANCA_GERADA – COBRANCA_NEGADA – COBRANCA_PAGA – FALHA_NA_VALIDACAO – PROCESSANDO_BAIXA_BOLETO – BOLETO_BAIXADO – BOLETO_NAO_BAIXADO – PROCESSANDO_ALTERACAO_VENCIMENTO – DATA_VENCIMENTO_ALTERADA – DATA_VENCIMENTO_NAO_ALTERADA – PROCESSANDO_PROTESTO – PROTESTADO – NAO_PROTESTADO – PROCESSANDO_SUSTACAO_PROTESTO – PROTESTO_SUSTADO – PROTESTO_NAO_SUSTADO – PROCESSANDO_ALTERACAO_VALOR – VALOR_ALTERADO – VALOR_NAO_ALTERADO – PROCESSANDO_ALTERACAO_JUROS – JUROS_ALTERADOS – JUROS_NAO_ALTERADOS – PROCESSANDO_ALTERACAO_MULTA – MULTA_ALTERADA – MULTA_NAO_ALTERADA – PROCESSANDO_ALTERACAO_DESCONTO – DESCONTO_ALTERADO – DESCONTO_NAO_ALTERADO – PROCESSANDO_CANCELAMENTO_BOLETO – BOLETO_CANCELADO – BOLETO_NAO_CANCELADO enumOrigemErro: description: Enumeration da origem do erro do título type: string enum: – BANKING – PARCEIRO – BANCO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recCobrancaESalesRetorno: description: Record da cobrança pix que foi retornado pelo parceiro eSales type: object required: – txid properties: txid: type: string maxLength: 255 description: Identificador da cobrança status: type: string allOf: – #/definitions/enumStatusRegistroCobrancaRetornoESales description: Status do registro da cobranca pagamentos: type: array items: type: object allOf: – #/definitions/recPagamentoRetornoESales description: Informações sobre pagamentos registro: type: object allOf: – #/definitions/recRegistroRetornoESales description: Registro da cobrança boleto: type: object allOf: – #/definitions/recBoletoESalesRetorno description: Informações exclusivas do boleto recRegistroRetornoESales: description: Record do registro da cobrança que foi retornada pelo parceiro eSales type: object required: – calendario properties: calendario: type: object allOf: – #/definitions/recCalendarioRetornoESales description: tempo da cobrança retornada pelo parceiro pixCopiaECola: type: string maxLength: 255 description: Pix copia e cola problema: type: object allOf: – #/definitions/recProblemaRetornoCobrancaESales description: Problema imagemBase64: type: string maxLength: 2048 description: Pix QRCode recCalendarioRetornoESales: description: Record de informações referente ao controle de tempo da cobrança retornada pelo parceiro type: object properties: criacao: type: string format: date-time description: Data de criação recProblemaRetornoCobrancaESales: description: Record do problema da cobrança retornada pelo parceiro type: object properties: type: type: string maxLength: 255 description: Tipo de problema type: string maxLength: 255 description: Título do problema status: type: integer format: int64 description: Status do problema detail: type: string maxLength: 255 description: Detalhe do problema violacoes: type: array items: type: object allOf: – #/definitions/recAvisosRetornoCobrancaESales description: Violações recAvisosRetornoCobrancaESales: description: Record do aviso da cobrança retornada pelo parceiro type: object properties: razao: type: string maxLength: 255 description: Razão propriedade: type: string maxLength: 255 description: Propriedade valor: type: string maxLength: 255 description: Valor recPagamentoRetornoESales: description: Record com informações relacionadas ao pagamento eSales type: object required: – valor – tipo – horario properties: valor: type: string description: Valor pago tipo: type: string maxLength: 255 description: Tipo da cobranca horario: type: string format: date-time description: Data e hora do pagamento infoPagador: type: string maxLength: 255 description: Informações do pagador endToEndId: type: string maxLength: 255 description: Identificador único do pagamento componentesValor: type: object allOf: – #/definitions/recComponentesValorESales description: Informações detalhada dos valores do pagamento recComponentesValorESales: description: Record com informações relacionadas ao detalhamente do valor pago no título – eSales type: object properties: original: type: object allOf: – #/definitions/recValorESales description: Valor original multa: type: object allOf: – #/definitions/recValorESales description: Valor multa juros: type: object allOf: – #/definitions/recValorESales description: Valor juros abatimento: type: object allOf: – #/definitions/recValorESales description: Valor abatimento desconto: type: object allOf: – #/definitions/recValorESales description: Valor desconto recValorESales: description: Record com detalhamento do valor – eSales type: object properties: valor: type: string description: Valor recBoletoESalesRetorno: description: Record com as informações exclusivas do boleto type: object properties: seuNumero: type: string maxLength: 255 description: Seu número nossoNumero: type: string maxLength: 255 description: Nosso número linhaDigitavel: type: string maxLength: 255 description: Linha digitável ocorrencias: type: array items: type: object allOf: – #/definitions/recOcorrenciaESalesRetorno description: Lista de ocorrências dataLiquidacao: type: string format: date description: Data de liquidação dataVencimento: type: string format: date description: Data de vencimento protesto: type: object allOf: – #/definitions/recProtesto description: Informações de protesto recOcorrenciaESalesRetorno: description: Record com a informação da ocorrência type: object properties: codigo: type: string maxLength: 255 description: Código descricao: type: string maxLength: 255 description: Descrição recProtesto: description: Record com as informações de protesto type: object required: – tipo properties: tipo: type: string allOf: – #/definitions/enumTipoProtesto description: Tipo de protesto prazo: type: integer format: int64 description: Prazo recCobrancaBtgRetorno: description: Record da cobrança pix que foi retornado pelo parceiro BTG type: object required: – bankSlipId – correlationId – amount – dueDate properties: bankSlipId: type: string maxLength: 255 description: Identificador da cobrança correlationId: type: string maxLength: 255 description: Identificador da correlação ourNumber: type: string maxLength: 255 description: Nosso número referenceNumber: type: string maxLength: 255 description: Seu número status: type: string allOf: – #/definitions/enumStatusRegistroCobrancaRetornoBtg description: Status do registro da cobranca barCode: type: string maxLength: 255 description: Código de barras digitableLine: type: string maxLength: 255 description: Linha digitável amount: type: string description: Valor da cobrança amountPaid: type: string description: Valor pago dueDate: type: string format: date description: Data de vencimento paidAt: type: string format: date description: Data de pagamento payee: type: object allOf: – #/definitions/recBeneficiario description: Dados do beneficiario payer: type: object allOf: – #/definitions/recPagador description: Dados do pagador pixInfo: type: object allOf: – #/definitions/recPixInfo description: Dados do pix errors: type: array items: type: object allOf: – #/definitions/recError description: Erros na geração do boleto recBeneficiario: description: Dados do pagador da cobrança type: object properties: accountId: type: string maxLength: 255 description: Dados da conta taxId: type: string maxLength: 255 description: CNPJ bankCode: type: string maxLength: 255 description: Código do banco branchCode: type: string maxLength: 255 description: Agência number: type: string maxLength: 255 description: Número da conta recPagador: description: Dados do pagador da cobrança type: object required: – taxId properties: name: type: string maxLength: 255 description: Nome taxId: type: string maxLength: 255 description: Número do documento recError: description: Erros na geração do boleto type: object properties: code: type: string maxLength: 255 description: Código do erro descriptiom: type: string maxLength: 255 description: Descrição do erro recPixInfo: description: Dados do pix type: object properties: emv: type: string maxLength: 255 description: Pix copia e cola key: type: string maxLength: 255 description: Chave Pix txId: type: string maxLength: 255 description: Identificador da cobrança emvUrl: type: string maxLength: 255 description: Pix QRCode cobrancaDadosBoleto: description: Entidade de dados da cobrança de boleto type: object required: – id – bancoRecebimento properties: id: type: string format: uuid description: Identificador do registro bancoRecebimento: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco de recebimento usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: cobrancaItemBoleto: description: Entidade de dados do título de cobrança boleto type: object required: – txid – seuNumero – situacao properties: id: type: string format: uuid description: Identificador do registro txid: type: string maxLength: 255 description: Identificador utilizado para comunicação com o parceiro cobrancaDadosBoleto: type: object allOf: – #/definitions/cobrancaDadosBoleto description: Cobrança de dados boleto relacionada seuNumero: type: string maxLength: 25 description: Seu número situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação do título cobrancaItemBoletoHistoricos: type: array items: type: object allOf: – #/definitions/cobrancaItemBoletoHistorico description: Histórico de atualizações da situação do título usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: cobrancaItemBoletoHistorico: description: Entidade de histórico do título de cobrança boleto type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Registro da cobrança item boleto situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItemDetalhes description: Situação mensagem: type: string maxLength: 255 description: Mensagem usuger: type: string maxLength: 255 description: dthger: type: string format: date-time description: usualt: type: string maxLength: 255 description: dthalt: type: string format: date-time description: editCobrancaItemBoletoHistorico: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoHistorico notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string maxLength: 255 description: message: type: string maxLength: 255 description: exceptionClass: type: string maxLength: 255 description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string maxLength: 255 description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string maxLength: 255 description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string maxLength: 255 description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string maxLength: 255 description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string maxLength: 255 description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string maxLength: 255 description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string maxLength: 255 description: beanClass: type: string maxLength: 255 description: serviceClass: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string maxLength: 255 description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string maxLength: 255 description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string maxLength: 255 description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string maxLength: 255 description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE