integration

2.0info: 3.69.0 integration description: Serviço para integração de títulos (receber) x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: integration 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: /integration/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 /integration/queries/getBankSlips: post: description: Query para buscar os boletos através de um lote financeiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: financialLotId: type: string description: Id do lote financeiro responses: 200: description: Ok schema: type: object properties: financialLotId: type: string description: Id do lote financeiro bankSlips: type: array items: type: object allOf: – #/definitions/bankSlip description: Boletos emails: type: array items: type: string description: Emails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para buscar os boletos através de um lote financeiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: financialLotId description: Id do lote financeiro in: query type: string responses: 200: description: Ok schema: type: object properties: financialLotId: type: string description: Id do lote financeiro bankSlips: type: array items: type: object allOf: – #/definitions/bankSlip description: Boletos emails: type: array items: type: string description: Emails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/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 /integration/actions/processarIntegracaoCobrancaBanking: post: description: Processar integração de títulos do contas a receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulosId properties: titulosId: type: array items: type: string minimum: 1 description: Lista de identificadores de títulos do contas a receber responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/signals/atualizarIntegracaoControladoriaTesouraria: post: description: Primitiva para atualizar indicativo de integração com a controladoria nos movimentos de tesouraria tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosGeraisAtualizacaoIntegracaoControladoria description: Dados para atualização responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/integracaoCobrancaBanking: post: description: Integração de títulos do contas a receber tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – titulosId properties: titulosId: type: array items: type: string minimum: 1 description: Lista de identificadores de títulos do contas a receber responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/atualizarIntegracaoControladoriaContasPagar: post: description: Primitiva para atualizar indicativo de integração com a controladoria nos movimentos do contas a pagar tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosGeraisAtualizacaoIntegracaoControladoria description: Dados para atualização responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/atualizarIntegracaoControladoriaContasReceber: post: description: Primitiva para atualizar indicativo de integração com a controladoria nos movimentos do contas a pagar tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosGeraisAtualizacaoIntegracaoControladoria description: Dados para atualização responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/atualizarInformacoesContabeisMovimentosTesouraria: post: description: Atualizar informações contábeis nos movimentos de tesouraria tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – input properties: input: type: object allOf: – #/definitions/recAtualizarInformacoesContabeisMovimentos description: Parâmetros de entrada responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/atualizarInformacoesContabeisMovimentosContasPagar: post: description: Atualizar informações contábeis nos movimentos de contas a pagar tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – input properties: input: type: object allOf: – #/definitions/recAtualizarInformacoesContabeisMovimentos description: Parâmetros de entrada responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/atualizarInformacoesContabeisMovimentosContasReceber: post: description: Atualizar informações contábeis nos movimentos de contas a receber tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – input properties: input: type: object allOf: – #/definitions/recAtualizarInformacoesContabeisMovimentos description: Parâmetros de entrada responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/atualizaSituacaoLoteFinanceiroSucesso: post: description: Primitiva para atualizar situação do lote financeiro tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – loteId properties: loteId: type: string description: Identificador mensagem: type: string description: Mensagem responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/events/geracaoBoletoTituloContasReceberEfetuadoComSucesso: post: description: Evento de geração do boleto x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – e301tcrId – mensagens properties: e301tcrId: type: string description: Id do título do boleto gerado mensagens: type: array items: type: string minimum: 1 description: Erros relacionados ao boleto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/geracaoBoletoTituloContasReceberComErro: post: description: Evento de geração do boleto quando ocorre erro x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – e301tcrId – mensagens properties: e301tcrId: type: string description: Id do título do boleto gerado mensagens: type: array items: type: string minimum: 1 description: Erros relacionados ao boleto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarIntegracaoContabilidadeTesourariaSucesso: post: description: Evento chamado após a atualização do indicativo de integração com a contabilidade nos movimentos de tesouraria x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosGeraisAtualizacaoIntegracaoControladoria description: Dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarIntegracaoContabilidadeTesourariaErro: post: description: Evento chamado quando houver algum erro na atualização do indicativo de integração com a contabilidade nos movimentos de tesouraria x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosAtualizacaoIntegracaoControladoriaError description: Dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarIntegracaoContabilidadeContasPagarSucesso: post: description: Evento chamado após a atualização do indicativo de integração com a contabilidade nos movimentos do contas a pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosGeraisAtualizacaoIntegracaoControladoria description: Dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarIntegracaoContabilidadeContasPagarErro: post: description: Evento chamado quando houver algum erro na atualização do indicativo de integração com a contabilidade nos movimentos do contas a pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosAtualizacaoIntegracaoControladoriaError description: Dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarIntegracaoContabilidadeContasReceberSucesso: post: description: Evento chamado após a atualização do indicativo de integração com a contabilidade nos movimentos do contas a receber x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosGeraisAtualizacaoIntegracaoControladoria description: Dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarIntegracaoContabilidadeContasReceberErro: post: description: Evento chamado quando houver algum erro na atualização do indicativo de integração com a contabilidade nos movimentos do contas a receber x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – params properties: params: type: object allOf: – #/definitions/recDadosAtualizacaoIntegracaoControladoriaError description: Dados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarInformacoesContabeisMovimentosContasPagarSucesso: post: description: Evento de sucesso a ser publicado após a atualização das informações contábeis nos movimentos de contas a pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Indentificador do processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarInformacoesContabeisMovimentosContasPagarErro: post: description: Evento de erro a ser publicado no processo de atualização das informações contábeis nos movimentos de contas a pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Indentificador do processo msgErro: type: string description: Mensagem de erro ocorrido no processo detalhesErro: type: string description: Detalhes do erro ocorrido no processo (stack trace) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarInformacoesContabeisMovimentosContasReceberSucesso: post: description: Evento de sucesso a ser publicado após a atualização das informações contábeis nos movimentos de contas a receber x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Indentificador do processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarInformacoesContabeisMovimentosContasReceberErro: post: description: Evento de erro a ser publicado no processo de atualização das informações contábeis nos movimentos de contas a receber x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Indentificador do processo msgErro: type: string description: Mensagem de erro ocorrido no processo detalhesErro: type: string description: Detalhes do erro ocorrido no processo (stack trace) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarInformacoesContabeisMovimentosTesourariaSucesso: post: description: Evento de sucesso a ser publicado após a atualização das informações contábeis nos movimentos de tesouraria x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Indentificador do processo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/atualizarInformacoesContabeisMovimentosTesourariaErro: post: description: Evento de erro a ser publicado no processo de atualização das informações contábeis nos movimentos de tesouraria x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticket properties: ticket: type: string description: Indentificador do processo msgErro: type: string description: Mensagem de erro ocorrido no processo detalhesErro: type: string description: Detalhes do erro ocorrido no processo (stack trace) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/bankSlipsGenerated: post: description: Evento de boletos gerados x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: financialLotId: type: string description: Id do lote financeiro bankSlips: type: array items: type: object allOf: – #/definitions/bankSlip description: Boletos emails: type: array items: type: string description: Emails responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumTipoIntegracaoControladoria: description: Tipo de integração da controladoria type: string enum: – CONTABILIDADE enumTipoAtualizacaoIntCtb: description: Tipo de atualização da integração da controladoria type: string enum: – ATUALIZAR – DESATUALIZAR enumSituacaoLoteFinanceiro: description: Situação Lote Financeiro type: string enum: – EM_PROCESSAMENTO – EM_PROCESSAMENTO_NOTA_GUIA – PROCESSADO_SUCESSO – PROCESSADO_ERRO – PROCESSADO_ERRO_GUIA – PROCESSADO_COM_PENDENCIA – EM_EXCLUSAO – EXCLUIDO_SUCESSO – EXCLUIDO_ERRO – EXCLUIDO_COM_PENDENCIA 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 recAtualizarInformacoesContabeisMovimentos: description: Parâmetros com informações contábeis a serem atualizados nos movimentos type: object required: – ticket – e640lotId – e640lotNum – movimentosId properties: ticket: type: string description: Ticket identificador do processo e640lotId: type: string description: Identificador do lote contábil e640lotNum: type: integer format: int64 description: Número do lote contábil movimentosId: type: array items: type: string minimum: 1 description: Lista de identificadores de movimentos a serem atualizados recDadosGeraisAtualizacaoIntegracaoControladoria: description: Record do input dos dados padrões utilizados em todos os eventos de integração da controladoria discriminator: _discriminator type: object required: – ticket – tipoIntegracao – tipoAtualizacao – movimentosId – _discriminator properties: ticket: type: string description: Indentificador de quem faz a chamada tipoIntegracao: type: string allOf: – #/definitions/enumTipoIntegracaoControladoria description: Tipo de integração tipoAtualizacao: type: string allOf: – #/definitions/enumTipoAtualizacaoIntCtb description: Tipo de atualização movimentosId: type: array items: type: string minimum: 1 description: Lista de identificadores de movimentos _discriminator: type: string description: recDadosAtualizacaoIntegracaoControladoriaError: description: Record padrão utilizado nas chamadas das actions de atualização de integração da controladoria allOf: – #/definitions/recDadosGeraisAtualizacaoIntegracaoControladoria – type: object properties: msgErro: type: string description: Mensagem de erro ocorrido no processo stack: type: string description: Stack do erro bankSlip: description: Record de informações do boleto type: object properties: name: type: string description: Nome do arquivo url: type: string description: Url do arquivo type: string description: Versão do arquivo securitiesNumber: type: string description: Número do título 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