2.0info: 3.35.0 cobranca_escritural description: Serviço de Cobrança Escritural x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: cobranca_escritural 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_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /cobranca_escritural/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço 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 geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço 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 geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/queries/baixarArquivo: post: description: Baixar arquivo da S3 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lote_financeiro_id properties: lote_financeiro_id: type: string description: Filtro com parâmetros de busca responses: 200: description: Ok schema: type: object required: – arquivo – nomeDoArquivo properties: arquivo: type: string format: byte description: Arquivo da S3 nomeDoArquivo: type: string description: Nome do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Baixar arquivo da S3 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: lote_financeiro_id description: Filtro com parâmetros de busca in: query required: true type: string responses: 200: description: Ok schema: type: object required: – arquivo – nomeDoArquivo properties: arquivo: type: string format: byte description: Arquivo da S3 nomeDoArquivo: type: string description: Nome do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/queries/obterTotalRemessaBanco: post: description: Retorna totais de titulos e instruções enviadas/não enviadas para o banco tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/recFilterTotalRemessaBanco description: Filtro com parâmetros de busca responses: 200: description: Ok schema: type: object required: – totais properties: totais: type: object allOf: – #/definitions/recTotalRemessaBanco description: totais filtrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/queries/obterTitulosInstrucaoBancaria: post: description: Retorna duplicatas a receber (obterTitulosInstrucaoBancaria) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pageRequest properties: filter: type: object allOf: – #/definitions/recFilterTitulosInstrucaoBancaria description: Filtro com os parâmetros de busca pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recObterTitulosInstrucaoBancaria description: Duplicatas a receber filtradas totalElements: type: integer format: int64 description: Total de duplicatas retornadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/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 /cobranca_escritural/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 /cobranca_escritural/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_escritural/actions/atualizarRetornoBancario: post: description: Atualizar registros de retorno de erros da e310hic tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – retornosBancario properties: retornosBancario: type: array items: type: object allOf: – #/definitions/recRetornoBancario minimum: 1 description: Lista com retornos bancários a serem atualizados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/actions/processarLoteInstrucaoBancaria: post: description: Irá processar o lote de instrução bancária (via tela) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – maioriaSelecionado – valoresPadroes properties: filter: type: object allOf: – #/definitions/recFilterTitulosInstrucaoBancaria description: Filtro com os parâmetros de busca selecionados: type: array items: type: string description: Identificadores dos títulos selecionados para processamento naoSelecionados: type: array items: type: string description: Identificadores dos títulos selecionados para não serem processados maioriaSelecionado: type: boolean description: Flag que identifica qual formato de restrição dos títulos a serem processados (selecionados/não selecionados) valoresPadroes: type: object allOf: – #/definitions/recInstrucaoBancariaValoresPadroes description: Valores inseridos via cabeçalho de tela para input nos títulos em lote editados: type: array items: type: object allOf: – #/definitions/recInstrucaoBancaria description: Registros editados manualmente em tela. (não utilizando cabeçalho de valores padrões) dataHora: type: string format: date-time description: Data hora do filtro responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/actions/gerarArquivoRemessa: post: description: Gera o arquivo de remessa para os dados informados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: empresas: type: array items: type: string description: Identificadores das empresas portadores: type: array items: type: string description: Identificadores dos portadores diasConsiderarVencimentoProrrogado: type: integer format: int64 description: Período a considerar os títulos com vencimento prorrogado, a partir da data atual responses: 200: description: Ok schema: type: object required: – sucesso – mensagem – urls properties: sucesso: type: boolean description: Indicador de sucesso na geração mensagem: type: string description: Mensagem de validação urls: type: array items: type: string minimum: 1 description: Lista de URLs de acesso aos recursos gerados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/actions/obterUrlUpload: post: description: Enviar um arquivo para a área temporária do bucket S3 e retorna dados para recuperação futura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nomeArquivo properties: nomeArquivo: type: string description: nome do arquivo anexo responses: 200: description: Ok schema: type: object required: – id – url – nome – versao properties: id: type: string description: Identificador do arquivo url: type: string description: URL do arquivo nome: type: string description: Nome do arquivo versao: type: string description: Versão do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/actions/processarRetorno: post: description: Recupera os arquivos informados, valida processa e envia para a área permanente do bucket S3 tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arquivos properties: arquivos: type: array items: type: object allOf: – #/definitions/recArquivo minimum: 1 description: Lista de arquivos responses: 200: description: Ok schema: type: object required: – mensagem properties: mensagem: type: string description: Aviso de processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca_escritural/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 /cobranca_escritural/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/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumSitReg: description: Situação do registro type: string enum: – VA – VI enumDebCre: description: Operação type: string enum: – VD – VC enumTipTrb: description: Tipo de transação bancária type: string enum: – VC – VD – VO enumProTer: description: Tipo de proprietário type: string enum: – VP – VT enumTipBai: description: Tipo de Baixa type: string enum: – VPG – VDV – VAB – VCA – VCR – VCP – VLP – VSU – VNA enumLisMod: description: Tipos de transação type: string enum: – VVEP – VVEO – VVEC – VVEF – VVES – VVEN – VESN – VESR – VESB – VESC – VESF – VCRE – VCRP – VCRB – VCRA – VRAM – VCRV – VCOO – VCSO – VCOF – VCOS – VCON – VCPE – VCPP – VCPB – VCPM – VCPA – VPAM – VCPV – VCBC – VCBM – VFTC – VPCP – VCFB – VPAT – VPRJ – VCCR – VCCP enumAplGrp: description: Grupo de aplicação type: string enum: – VA – VR – VP enumTipItb: description: Tipo de Instrução type: string enum: – VA – VM enumTipNtg: description: Tipo da Natureza de Gasto type: string enum: – VN – VT – VR enumTipHis: description: Tipo histórico type: string enum: – VB – VT – VI – VR – VP – VC enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – Asc – Desc 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 description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recRetornoBancario: description: Record para o payload de atualização dos retornos bancários da tabela e310hic type: object required: – fatoFinanceiroId properties: fatoFinanceiroId: type: string description: Fato financeiro tratado: type: boolean description: Indica se foi tratado default: false observacao: type: string maxLength: 250 description: Observação recFilterTotalRemessaBanco: description: Record de filtros da primitiva obterTotalRemessaBanco type: object properties: e070emp_id: type: string description: Empresa e039por_id: type: string description: Portador vctPro_final: type: string format: date description: Vencimento prorrogado final recTotalRemessaBanco: description: Record de totais da primitiva obterTotalRemessaBanco type: object required: – totalInstrucoes – totalInstrucoesPendentesRemessa – totalTitulosPendentesRemessa properties: totalInstrucoes: type: integer format: int64 description: Total de instruções totalInstrucoesPendentesRemessa: type: integer format: int64 description: Total de instruções pendentes de remessa totalTitulosPendentesRemessa: type: integer format: int64 description: Total de títulos pendentes de remessa recObterTitulosInstrucaoBancaria: description: Record de retorno da primitiva obterTitulosInstrucaoBancaria type: object required: – e301tcr_id – e070fil – numTit – e002tpt – e039por – e033crt – e030ban properties: e301tcr_id: type: string description: Identificador do título e070fil: type: object allOf: – #/definitions/recGenerico description: Filial do título numTit: type: string description: Número do título e002tpt: type: object allOf: – #/definitions/recGenerico description: Tipo do título e039por: type: object allOf: – #/definitions/recGenerico description: Portador do título e033crt: type: object allOf: – #/definitions/recGenerico description: Carteira do título e030ban: type: object allOf: – #/definitions/recGenerico description: Banco recFilterTitulosInstrucaoBancaria: description: Record de filtros da primitiva obterTitulosInstrucaoBancaria type: object required: – e070emp_id properties: e070emp_id: type: string description: Empresa e070fil_id: type: string description: Filial e001pes_id: type: array items: type: string description: Cliente e001tns_id: type: array items: type: string description: Transação e066fpg_id: type: array items: type: string description: Forma pagamento e002tpt_id: type: array items: type: string description: Tipo e039por_id: type: array items: type: string description: Portador e047ntg_id: type: array items: type: string description: Natureza gasto e023crp_id: type: array items: type: string description: Grupo e301tcr_id: type: array items: type: string description: Título vctPro_inicial: type: string format: date description: Vencimento prorrogado inicial vctPro_final: type: string format: date description: Vencimento prorrogado final datEmi_inicial: type: string format: date description: Emissão inicial datEmi_final: type: string format: date description: Emissão final vlrAbe_inicial: type: string description: Valor incial vlrAbe_final: type: string description: Valor final recPageRequest: description: Record de paginação e ordenação de registros type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de páginas orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Record do 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) recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id properties: id: type: string description: Identificador label: type: string description: Código + Descrição codigo: type: string description: Código de negócio descricao: type: string description: Descrição de negócio recInstrucaoBancaria: description: Record para armazenar instruções editadas manualmente allOf: – #/definitions/recBaseInstrucaoBancaria – type: object required: – e301tcr_id – e035ocr_id properties: e301tcr_id: type: string description: Identificador do título e035ocr_id: type: string description: Identificador da Ocorrência recInstrucaoBancariaValoresPadroes: description: Record base com a ocorrência se necessária para emissão de instrução bancária allOf: – #/definitions/recBaseInstrucaoBancaria – type: object properties: e035ocr_id: type: string description: Identificador da Ocorrência recBaseInstrucaoBancaria: description: Record base das informações necessárias para emissão de instrução bancária discriminator: _discriminator type: object required: – e036ins_id_ins1 – e036ins_id_ins2 – _discriminator properties: e036ins_id_ins1: type: string description: Identificador da primeira instrução qtdDi1: type: integer format: int64 description: Quantidade de dias base da primeira instrução datBa1: type: string format: date description: Data base para primeira instrução perBa1: type: string description: Percentual base da primeira instrução minimum: 0 vlrBa1: type: string description: Valor base da primeira instrução e036ins_id_ins2: type: string description: Identificador da segunda instrução qtdDi2: type: integer format: int64 description: Quantidade de dias base da segunda instrução datBa2: type: string format: date description: Data base para segunda instrução perBa2: type: string description: Percentual base da segunda instrução minimum: 0 vlrBa2: type: string description: Valor base da segunda instrução obsItb: type: string maxLength: 250 description: Texto da observação _discriminator: type: string description: recArquivo: description: Record com dados de um arquivo enviado para o bucket S3 type: object required: – id – url – nome – versao properties: id: type: string description: Id do arquivo url: type: string description: URL do arquivo nome: type: string description: Nome do arquivo versao: type: string description: Versão do arquivo 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. 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 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