register_boleto

2.0info: 1.7.2 register_boleto description: Serviço de fachada para APIs públicas de cobrança via boleto x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: register_boleto contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_bnk_cobsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /register_boleto/queries/healthcheck: post: description: Query for health check – SRE tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_boleto/queries/getStatusBankSlipBilling: post: description: Query de listagem do status dos títulos de cobrança boleto\n### Resources\n- res://senior.com.br/erpx_bnk_cob/register_boleto/queries/getStatusBankSlipBilling tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filter: type: object allOf: – #/definitions/recFilterGetStatusBankSlipBilling description: Filtro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – recBankSlipBilling properties: recBankSlipBilling: type: array items: type: object allOf: – #/definitions/recBankSlipBilling minimum: 1 description: Dados da cobrança boleto 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não encontrado default: description: Error response schema: #/definitions/genericError /register_boleto/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_boleto/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /register_boleto/actions/registerBankSlipBilling: post: description: API responsável pela criação do registro de cobrança assíncrona de boleto\n### Resources\n- res://senior.com.br/erpx_bnk_cob/register_boleto/actions/registerBankSlipBilling tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – receivableBank – beneficiary – accountsReceivable properties: receivableBank: type: string allOf: – #/definitions/enumReceivableBank description: Banco do recebimento beneficiary: type: object allOf: – #/definitions/recBeneficiary description: Dados do beneficiário accountsReceivable: type: array items: type: object allOf: – #/definitions/recAccountReceivable minimum: 1 description: Lista de títulos que serão registrados as cobranças responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /register_boleto/actions/registerBankSlipOperation: post: description: API responsável pela execução de operações sobre o registro de cobrança do boleto\n### Resources\n- res://senior.com.br/erpx_bnk_cob/register_boleto/actions/registerBankSlipOperation tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processId – operationType – accountsReceivableId properties: processId: type: string maxLength: 255 description: Id do processo operationType: type: string allOf: – #/definitions/enumOperationType description: Tipo de operação a ser executada accountsReceivableId: type: array items: type: string maxLength: 255 minimum: 1 description: Lista de identificadores dos títulos a serem processados dueDate: type: string format: date description: Nova data de vencimento protest: type: object allOf: – #/definitions/protest description: Protesto newValue: type: string description: Novo valor interest: type: object allOf: – #/definitions/recCalculationInterest description: Juros assessment: type: object allOf: – #/definitions/recCalculationValue description: Multas discount: type: object allOf: – #/definitions/recCalculationDiscount description: Descontos responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string maxLength: 255 description: Id do processo 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumReceivableBank: description: Enumeration de bancos de recebimento type: string enum: – BANCO_DO_BRASIL – SANTANDER – CAIXA_ECONOMICA_FEDERAL – BRADESCO – ITAU – SICREDI – BTG_PACTUAL enumOperationType: description: Enumeration de tipos de operações boleto type: string enum: – WRITE_OFF – CHANGE_DUE_DATE – PROTEST – CANCEL_PROTEST – CHANGE_VALUE – CHANGE_INTEREST – CHANGE_ASSESSMENT – CHANGE_DISCOUNT – CANCEL_BANK_SLIP enumCalculationType: description: Enumeration do tipo de cálculo dos valores de cobrança do título type: string enum: – PERCENTAGE – FIXED_VALUE enumCalculationTypeDiscount: description: Enumeration do tipo de cálculo dos valores de desconto do título type: string enum: – FIXED_VALUE_UNTIL_LIMIT_DATE – PERCENTAGE_UNTIL_LIMIT_DATE enumCalculationTypeInterest: description: Enumeration do tipo de cálculo dos valores de juros do título type: string enum: – VALUE_FOR_CALENDAR_DAYS – PERCENTAGE_FOR_CALENDAR_DAYS enumSpecie: description: Enumeration de espécie type: string enum: – COMMERCIAL_DUPLICATE – SERVICE_DUPLICATE enumWallet: description: Enumeration de carteira type: string enum: – SIMPLE – DISCOUNTED – SECURED enumProtestType: description: Enumeration dos tipos de protestos type: string enum: – CALENDAR_DAYS – BUSINESS_DAYS – NO_PROTEST enumBancoRecebimento: description: Enumeration dos bancos de recebimento type: string enum: – BANCO_DO_BRASIL – SANTANDER – CAIXA_ECONOMICA_FEDERAL – BRADESCO – ITAU – SICREDI – BTG_PACTUAL enumEspecie: description: Enumeration de espécie type: string enum: – DUPLICATA_MERCANTIL – DUPLICATA_SERVICO enumCarteira: description: Enumeration de carteira type: string enum: – SIMPLES – DESCONTADA – CAUCIONADA enumTipoCalculoJuros: description: Enumeration do tipo de cálculo dos valores de juros do título type: string enum: – VALOR_DIAS_CORRIDOS – PERCENTUAL_AO_DIA_DIAS_CORRIDOS enumTipoCalculo: description: Enumeration do tipo de cálculo dos valores de cobrança do título type: string enum: – PERCENTUAL – VALOR_FIXO enumTipoCalculoDesconto: description: Enumeration do tipo de cálculo dos valores de desconto do título type: string enum: – VALOR_FIXO_ATE_DATA_INFORMADA – PERCENTUAL_FIXO_ATE_DATA_INFORMADA enumTipoProtesto: description: Enumeration dos tipos de protestos type: string enum: – DIAS_CORRIDOS – DIAS_UTEIS – NAO_PROTESTAR enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumBankSlipBillingItemsSituation: description: Enumeration de situação da cobrança item type: string enum: – AWAITING_BILLING – PROCESSING_BILLING_SEND – BILLING_SENT – BILLING_WITH_PROBLEMS – BILLING_GENERATED – BILLING_DENIED – BILLING_PAID – BILLING_UNFIT_FOR_PROCESSING – BILLING_INACTIVATED – UNEXPECTED_ERROR – VALIDATION_FAILURE – CANCELLING_BILLING – BILLING_CANCELLED – BILLING_CANCELLATION_ERROR 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 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 recBeneficiary: description: Record de dados do beneficiário type: object required: – documentNumber – covenant – branchNumber – accountNumber properties: name: type: string maxLength: 255 description: Nome do beneficiário documentNumber: type: string maxLength: 255 description: Número do documento covenant: type: string maxLength: 20 description: Convênio branchNumber: type: string maxLength: 5 description: Número da agência branchDigit: type: string maxLength: 2 description: Dígito da agência accountNumber: type: string maxLength: 15 description: Número da conta accountDigit: type: string maxLength: 2 description: Dígito da conta recAccountReceivable: description: Record com as informações do título para registro de cobrança type: object required: – accountReceivableId – accountReceivableNumber – accountReceivableType – yourNumber – customer – dueDate – values properties: accountReceivableId: type: string maxLength: 255 description: Identificador do título accountReceivableNumber: type: string maxLength: 255 description: Número do título accountReceivableType: type: string maxLength: 255 description: Tipo do título yourNumber: type: string maxLength: 25 description: Seu número ourNumber: type: string maxLength: 20 description: Nosso número customer: type: object allOf: – #/definitions/recCustomer description: Identificador do cliente dueDate: type: string format: date description: Data de vencimento specie: type: string allOf: – #/definitions/enumSpecie description: Espécie wallet: type: string allOf: – #/definitions/enumWallet description: Carteira guarantor: type: object allOf: – #/definitions/recGuarantor description: Avalista values: type: object allOf: – #/definitions/recValuesRegisterBilling description: Valores do título protest: type: object allOf: – #/definitions/recProtest description: Protesto messages: type: array items: type: string maxLength: 255 description: Mensagens generatePixQrCode: type: boolean description: Gerar no boleto QR code para pagamento via Pix default: false recCustomer: description: Record de identificação do cliente type: object properties: id: type: string maxLength: 255 description: Identificador do registro na plataforma documentNumber: type: string maxLength: 14 description: Número do documento name: type: string maxLength: 100 description: Nome tradeName: type: string maxLength: 50 description: Nome fantasia address: type: object allOf: – #/definitions/recAddress description: Endereço email: type: string maxLength: 100 description: Email phoneNumber: type: string maxLength: 20 description: Número de telefone codPes: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 recAddress: description: Record com as informações de endereço type: object required: – street – country – state – city – postalCode properties: street: type: string maxLength: 100 description: Rua number: type: string maxLength: 60 description: Número neighborhood: type: string maxLength: 75 description: Bairro country: type: object allOf: – #/definitions/recCountry description: País state: type: object allOf: – #/definitions/recState description: Estado city: type: object allOf: – #/definitions/recCity description: Cidade postalCode: type: string maxLength: 20 description: Código postal (CEP) recState: description: Record do estado type: object properties: id: type: string maxLength: 255 description: Identificador do registro no foundation code: type: string maxLength: 2 description: Código protest: description: Record dos dados para protesto type: object required: – type – deadline properties: type: type: string allOf: – #/definitions/enumProtestType description: Tipo do protesto deadline: type: integer format: int64 description: Prazo do protesto minimum: 0 recCity: description: Record da cidade type: object properties: id: type: string maxLength: 255 description: Identificador do registro no foundation code: type: integer format: int64 description: Código recCountry: description: Record do país type: object properties: id: type: string maxLength: 255 description: Identificador do registro no foundation code: type: string maxLength: 255 description: Código recGuarantor: description: Record do avalista type: object required: – name – documentNumber properties: name: type: string maxLength: 255 description: Nome do avalista documentNumber: type: string maxLength: 14 description: Documento do avalista recValuesRegisterBilling: description: Record de valores do título de cobrança type: object required: – original properties: original: type: string description: Valor original minimum: 0.00 interest: type: object allOf: – #/definitions/recCalculationInterest description: Juros assessment: type: object allOf: – #/definitions/recCalculationValue description: Multas rebate: type: object allOf: – #/definitions/recCalculationValue description: Abatimentos discount: type: object allOf: – #/definitions/recCalculationDiscount description: Descontos recCalculationValue: description: Record das regras de cálculos dos valores type: object required: – calculationType – valueOrPercentage properties: calculationType: type: string allOf: – #/definitions/enumCalculationType description: Tipo de cálculo valueOrPercentage: type: string description: Valor ou porcentual minimum: 0.00 recCalculationInterest: description: Record das regras de cálculos dos juros type: object required: – calculationType – valueOrPercentage properties: calculationType: type: string allOf: – #/definitions/enumCalculationTypeInterest description: Tipo de cálculo valueOrPercentage: type: string description: Valor ou porcentual minimum: 0.00 recCalculationDiscount: description: Record das regras de cálculos dos descontos type: object required: – calculationType – discountFixedDate properties: calculationType: type: string allOf: – #/definitions/enumCalculationTypeDiscount description: Tipo de cálculo discountFixedDate: type: array items: type: object allOf: – #/definitions/recDiscountFixedDate minimum: 1 description: Descontos definidos de acordo com a data estabelecida recDiscountFixedDate: description: Record de descontos de acordo com uma data estabelecida type: object required: – limitDate – valueOrPercentage properties: limitDate: type: string format: date description: Data limite valueOrPercentage: type: string description: Valor ou percentual minimum: 0.00 recProtest: description: Record com as informações de protesto type: object required: – type properties: type: type: string allOf: – #/definitions/enumProtestType description: Tipo de protesto deadline: type: integer format: int64 description: Prazo recFilterGetStatusBankSlipBilling: description: Record do filtro de status dos títulos de cobrança boleto type: object properties: billingId: type: array items: type: string maxLength: 255 description: Lista de Identificadores dos títulos startDate: type: string format: date description: Data de emissão inicial endDate: type: string format: date description: Data de emissão final recPageRequest: description: Record para paginação e ordenação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string maxLength: 255 description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recBankSlipBilling: description: Record de dados da cobrança de boleto type: object required: – accountReceivableId – situation – digitableLine properties: accountReceivableId: type: string maxLength: 255 description: Identificador do título situation: type: string allOf: – #/definitions/enumBankSlipBillingItemsSituation description: Situação do título digitableLine: type: string maxLength: 255 description: Linha digitável ourNumber: type: string maxLength: 20 description: Nosso número pixCopyAndPaste: type: string maxLength: 255 description: Pix copia e cola pixQRCode: type: string maxLength: 255 description: Pix QRCode amountPaid: type: string description: Valor Pago originalValue: type: string description: Valor original rebateValue: type: string description: Valor abatimento assessmentValue: type: string description: Valor multa discountValue: type: string description: Valor desconto interestValue: type: string description: Valor juros settlementDate: type: string format: date description: Data liquidação occurrenceCode: type: string maxLength: 255 description: Código da ocorrência occurrenceDescription: type: string maxLength: 255 description: Descrição da ocorrência description: type: array items: type: string maxLength: 255 description: Lista de motivos da ocorrências errors: type: array items: type: object allOf: – #/definitions/recError description: Lista de erros na geração do boleto recError: description: Record com informações de erro do boleto type: object required: – message properties: message: type: string maxLength: 255 description: Mensagem de erro field: type: string maxLength: 255 description: Campo do erro 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. 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