• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/edocsx_dere/issuer
Mais pesquisados:Customização, Tutorial, Documentação

issuer

11 views 0 09/11/2026 integrador

2.0info: 3.7.2 issuer description: issuer x-senior-domain: edocsx_dere x-senior-domain-path: edocsx_dere x-senior-service-path: issuer 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/edocsx_deresecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /issuer/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 /issuer/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 /issuer/queries/retrieveIntegrationIssueXml: post: description: Busca o XML da crítica de integração salvo no DynamoDB tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – integrationIssueId properties: integrationIssueId: type: string description: Identificador da crítica de integração responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationIssueXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o XML da crítica de integração salvo no DynamoDB tags: – Queries x-senior-visibility: PRIVATE parameters: – name: integrationIssueId description: Identificador da crítica de integração in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationIssueXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/getAllDereParameters: post: description: Busca todos os valores de parâmetros para empresa ou filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: e070empId: type: string description: Id da empresa e070filId: type: string description: Id da filial responses: 200: description: Ok schema: type: object required: – parameters properties: parameters: type: array items: type: object allOf: – #/definitions/dereParameterRecord minimum: 1 description: Lista de parâmetros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todos os valores de parâmetros para empresa ou filial tags: – Queries x-senior-visibility: PRIVATE parameters: – name: e070empId description: Id da empresa in: query type: string – name: e070filId description: Id da filial in: query type: string responses: 200: description: Ok schema: type: object required: – parameters properties: parameters: type: array items: type: object allOf: – #/definitions/dereParameterRecord minimum: 1 description: Lista de parâmetros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/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 /issuer/queries/exportOutgoingDereEvent: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingDereEventXml: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingDereEventRejection: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingDereEventOccurrence: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingDereEventHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingDereEventHistoryDetails: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingDereBatch: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportDereBatchEventLink: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportDereSchema: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportDereXsd: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070empCertificate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070filCertificate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportIntegrationIssue: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportDereParameter: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/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 /issuer/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/forceMigrateSchema: post: description: Executa o migrateSchema removendo o tenant atual do cache da migração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/initialLoadDefaultBase: post: description: Carga inicial de dados da base padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: wizardCall: type: boolean description: Indica se quem está chamando a carga inicial é o Wizard na preparação de ambiente responses: 200: description: Ok schema: type: object properties: migrationVersion: type: string description: Indica a versão do migration migrated: type: boolean description: Indica se já foi migrado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/resetSchema: post: description: Realiza a limpeza da base de dados, mantendo somente os dados padrões (conforme carga inicial) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/resetMigrationCacheForCurrentTenant: post: description: Reseta o cache de migração para o tenant atual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/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 /issuer/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/receiveOutgoingDereEvent: post: description: Endpoint que inicia o processamento de um evento DeRE tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – documentId – xml properties: branchId: type: string description: Id da filial documentId: type: string description: Id do documento no ERPX xml: type: string description: XML do evento DeRE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/downloadDereOutgoing: post: description: Realiza o download do XML do evento DeRE de saída tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/dereDownloadRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/dereDownloadResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/rejectPendingDereEvent: post: description: Rejeita manualmente um evento DeRE que está pendente de processamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventAccessKey properties: eventAccessKey: type: string description: Identificador do evento DeRE (eventAccessKey da API DeRE) responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/resendOutgoingDereEvent: post: description: Reenvia um evento DeRE ao fluxo de processamento (rejeita automaticamente eventos pendentes que estouraram o timeout, sem notificar o ERP, e reprocessa o XML integrado a partir da assinatura) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do evento DeRE (eventId da API DeRE) responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/resendDereReceiptAlert: post: description: Reenvia manualmente ao ERP o alerta de resultado final (alertOutgoingDereReceipt) de um evento DeRE já finalizado (autorizado ou rejeitado). tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventAccessKey properties: eventAccessKey: type: string description: Identificador do evento DeRE (eventAccessKey da API DeRE) responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/queryDereEventStatus: post: description: Solicita manualmente a consulta de status de um evento DeRE que está aguardando processamento (IN_PROGRESS). Dispara a segunda etapa (D-9001) via queryAsync. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventAccessKey properties: eventAccessKey: type: string description: Identificador do evento DeRE (eventAccessKey da API DeRE) responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/saveDereParameters: post: description: Salva os parâmetros de DeRE para empresa ou filial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parameters properties: e070empId: type: string description: Id da empresa e070filId: type: string description: Id da filial parameters: type: array items: type: object allOf: – #/definitions/dereParameterRecord minimum: 1 description: Lista de parâmetros responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/queryDereStatus: post: description: Consulta a situação atual de um evento DeRE de saída a partir do identificador do documento no ERP tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Identificador do documento no ERP (mesmo documentId informado no receiveOutgoingDereEvent) responses: 200: description: Ok schema: type: object required: – documentId – situation properties: documentId: type: string description: Identificador do documento no ERP nrRecibo: type: string description: Número do recibo (preenchido apenas quando disponível) situation: type: string description: Situação atual do evento DeRE authorizationProtocol: type: string description: Protocolo do lote em que o evento foi recebido pelo Ambiente Nacional (preenchido apenas quando disponível) authorizationDate: type: string description: Data e hora da situação do evento (formato ISO 8601, preenchido apenas quando disponível) mensagem: type: string description: Mensagem do motivo da situação (preenchido em caso de rejeição) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/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 /issuer/actions/importOutgoingDereEvent: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingDereEventXml: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingDereEventRejection: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingDereEventOccurrence: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingDereEventHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingDereEventHistoryDetails: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingDereBatch: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importDereBatchEventLink: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importDereSchema: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importDereXsd: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070empCertificate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070filCertificate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importIntegrationIssue: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importDereParameter: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/signals/prepareDereBatch: post: description: Agrupa eventos DeRE pendentes em lotes para envio à API REST do Ambiente Nacional. Disparado por cron job ou volume threshold. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/sendDereBatch: post: description: Envia um lote DeRE montado ao Ambiente Nacional via edocsx-common-sefaz-gateway. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – batchId properties: batchId: type: string description: Identificador do lote a ser enviado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/retryFailedDereBatches: post: description: Reprocessa lotes DeRE que falharam no envio (retry com backoff exponencial). Disparado por cron job. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/loadDereXsdCache: post: description: Pré-carrega o cache de XSDs DeRE a partir do common-foundation. Disparado no startup do serviço. tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/dereProtocolReceived: post: description: Processa o Protocolo de Recebimento (1ª etapa síncrona) retornado pelo Ambiente Nacional após envio do lote DeRE. Disparado pelo callback do edocsx-common-sefaz-gateway. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – batchId – batchProtocol – dhRecepcao – cdResposta properties: batchId: type: string description: Identificador do lote batchProtocol: type: string description: Protocolo de recebimento do lote dhRecepcao: type: string description: Data e hora da recepção pelo Ambiente Nacional versaoAplicativoRecepcao: type: string description: Versão do aplicativo de recepção do Ambiente Nacional cdResposta: type: integer format: int64 description: Código de resposta (1=Aguardando, 7=Não recebido, 9=Erro interno) msgResposta: type: string description: Mensagem de resposta responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/dereReceiptProcessed: post: description: Processa o resultado final do processamento de um evento de retorno DeRE – 2ª etapa assíncrona. Disparado pelo callback do edocsx-common-sefaz-gateway. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventAccessKey – occurrences properties: eventAccessKey: type: string description: Identificador do evento DeRE cdRetorno: type: integer format: int64 description: Código de retorno da SEFAZ (1=sucesso, 0=erro) nrRecibo: type: string description: Número do recibo (preenchido apenas em sucesso) nrRetificacao: type: string description: Número de retificação dhProcessamento: type: string description: Data e hora do processamento occurrences: type: array items: type: object allOf: – #/definitions/dereReceiptOccurrence minimum: 1 description: Ocorrências de processamento (até 10) xmlResponse: type: string description: XML de retorno do evento (base64 encoded) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/registerIntegrationIssue: post: description: Registra crítica de integração tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – issue properties: documentId: type: string description: Chave informada na requisição issue: type: string description: Mensagem da crítica de integração eventType: type: string allOf: – #/definitions/enumDereEventType description: Tipo do evento que gerou a crítica xml: type: string description: XML que gerou a crítica responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/dereSigned: post: description: Callback da assinatura digital do evento DeRE tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – statusSign – correlationId properties: statusSign: type: string allOf: – #/definitions/statusSign description: Status da assinatura correlationId: type: string description: ID de correlação (UUID do outgoingDereEvent) signedXml: type: string description: XML assinado (presente apenas em caso de sucesso) errorMessage: type: string description: Mensagem de erro (presente apenas em caso de falha) digestValue: type: string description: Valor do digest da assinatura responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/dereBatchReceptionResponse: post: description: Callback do resultado da 1ª etapa (protocolo de recebimento) após envio do lote DeRE ao Ambiente Nacional (payload TransmissionRestOutput do sefaz_gateway) tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – httpStatusCode – responseTimeMs properties: response: type: string description: Resposta XML do Ambiente Nacional (pode vir vazia em caso de erro) httpStatusCode: type: integer format: int64 description: Código de status HTTP da resposta correlationId: type: string description: Identificador de correlação (id do lote DeRE) errorType: type: string description: Tipo de erro ocorrido no gateway errorMessage: type: string description: Mensagem descritiva do erro (pode conter o XML de retorno em erros HTTP) responseTimeMs: type: integer format: int64 description: Tempo de resposta em milissegundos responseType: type: string description: Tipo de resposta retornada attempt: type: integer format: int64 description: Número da tentativa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/dereBatchQueryResponse: post: description: Callback do resultado da 2ª etapa (D-9001 com resultado por evento) após processamento pelo Ambiente Nacional (payload TransmissionRestOutput do sefaz_gateway) tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – httpStatusCode – responseTimeMs properties: response: type: string description: Resposta XML do Ambiente Nacional (pode vir vazia em caso de erro) httpStatusCode: type: integer format: int64 description: Código de status HTTP da resposta correlationId: type: string description: Identificador de correlação (id do lote DeRE) errorType: type: string description: Tipo de erro ocorrido no gateway errorMessage: type: string description: Mensagem descritiva do erro (pode conter o XML de retorno em erros HTTP) responseTimeMs: type: integer format: int64 description: Tempo de resposta em milissegundos responseType: type: string description: Tipo de resposta retornada attempt: type: integer format: int64 description: Número da tentativa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/events/alertOutgoingDereProtocol: post: description: Notifica o ERP sobre o protocolo de recebimento de um evento DeRE (consumido por integrações externas) x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventAccessKey – batchProtocol – dhRecepcao properties: eventAccessKey: type: string description: Identificador do evento DeRE batchProtocol: type: string description: Protocolo de recebimento do lote dhRecepcao: type: string description: Data e hora da recepção pelo Ambiente Nacional responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/alertOutgoingDereReceipt: post: description: Notifica o ERP sobre o resultado final do processamento de um evento DeRE (autorizado ou rejeitado na 2ª etapa assíncrona – D-9001) x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventAccessKey – situation properties: eventAccessKey: type: string description: Identificador único do evento DeRE (eventAccessKey da API DeRE) nrRecibo: type: string description: Número do recibo (preenchido apenas em sucesso) situation: type: string description: Situação final do evento (AUTHORIZED ou REJECTED) authorizationProtocol: type: string description: Protocolo do lote em que o evento foi recebido pelo Ambiente Nacional (preenchido apenas em sucesso) authorizationDate: type: string description: Data e hora da situação final do evento (formato ISO 8601) mensagem: type: string description: Mensagem do motivo da situação (preenchido em rejeição) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/dereParameterChanged: post: description: Evento para notificar a alteração dos parâmetros de DeRE x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – parameters properties: e070empId: type: string description: Id da empresa e070filId: type: string description: Id da filial parameters: type: array items: type: object allOf: – #/definitions/dereParameterRecord minimum: 1 description: Lista de parâmetros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importOutgoingDereEventEvent: 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 /issuer/events/exportOutgoingDereEventEvent: 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 /issuer/events/importOutgoingDereEventXmlEvent: 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 /issuer/events/exportOutgoingDereEventXmlEvent: 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 /issuer/events/importOutgoingDereEventRejectionEvent: 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 /issuer/events/exportOutgoingDereEventRejectionEvent: 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 /issuer/events/importOutgoingDereEventOccurrenceEvent: 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 /issuer/events/exportOutgoingDereEventOccurrenceEvent: 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 /issuer/events/importOutgoingDereEventHistoryEvent: 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 /issuer/events/exportOutgoingDereEventHistoryEvent: 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 /issuer/events/importOutgoingDereEventHistoryDetailsEvent: 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 /issuer/events/exportOutgoingDereEventHistoryDetailsEvent: 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 /issuer/events/importOutgoingDereBatchEvent: 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 /issuer/events/exportOutgoingDereBatchEvent: 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 /issuer/events/importDereBatchEventLinkEvent: 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 /issuer/events/exportDereBatchEventLinkEvent: 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 /issuer/events/importDereSchemaEvent: 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 /issuer/events/exportDereSchemaEvent: 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 /issuer/events/importDereXsdEvent: 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 /issuer/events/exportDereXsdEvent: 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 /issuer/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE070empCertificateEvent: 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 /issuer/events/exportE070empCertificateEvent: 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 /issuer/events/importE070filCertificateEvent: 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 /issuer/events/exportE070filCertificateEvent: 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 /issuer/events/importIntegrationIssueEvent: 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 /issuer/events/exportIntegrationIssueEvent: 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 /issuer/events/importDereParameterEvent: 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 /issuer/events/exportDereParameterEvent: 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 /issuer/entities/outgoingDereEvent: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEvent responses: 200: description: The created resource schema: #/definitions/outgoingDereEvent 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: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEvent responses: 200: description: The created resource schema: #/definitions/outgoingDereEvent 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDereEvent responses: 200: description: Ok schema: #/definitions/editOutgoingDereEvent 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDereEvent responses: 200: description: Ok schema: #/definitions/outgoingDereEvent 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDereEvent 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDereEvent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventXml: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventXml responses: 200: description: The created resource schema: #/definitions/outgoingDereEventXml 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: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventXml responses: 200: description: The created resource schema: #/definitions/outgoingDereEventXml 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventXml/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDereEventXml responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventXml 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDereEventXml responses: 200: description: Ok schema: #/definitions/outgoingDereEventXml 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDereEventXml 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/{parentId}/eventXmls: 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/outgoingDereEventXml responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingDereEventXml 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/outgoingDereEventXml responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingDereEventXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/{parentId}/eventXmls/{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/editOutgoingDereEventXml responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventXml 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/outgoingDereEventXml responses: 200: description: Ok schema: #/definitions/outgoingDereEventXml 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/outgoingDereEventXml 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 /issuer/entities/outgoingDereEventXml/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDereEventXml responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventRejection: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventRejection responses: 200: description: The created resource schema: #/definitions/outgoingDereEventRejection 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: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventRejection responses: 200: description: The created resource schema: #/definitions/outgoingDereEventRejection 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventRejection/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDereEventRejection responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventRejection 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDereEventRejection responses: 200: description: Ok schema: #/definitions/outgoingDereEventRejection 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDereEventRejection 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/{parentId}/eventRejection: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventRejection responses: 200: description: The created resource schema: #/definitions/outgoingDereEventRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventRejection responses: 200: description: The created resource schema: #/definitions/outgoingDereEventRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/{parentId}/eventRejection/{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/editOutgoingDereEventRejection responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventRejection 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/outgoingDereEventRejection responses: 200: description: Ok schema: #/definitions/outgoingDereEventRejection 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/outgoingDereEventRejection 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 /issuer/entities/outgoingDereEventRejection/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDereEventRejection responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventOccurrence: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventOccurrence responses: 200: description: The created resource schema: #/definitions/outgoingDereEventOccurrence 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: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventOccurrence responses: 200: description: The created resource schema: #/definitions/outgoingDereEventOccurrence 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventOccurrence/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDereEventOccurrence responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventOccurrence 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDereEventOccurrence responses: 200: description: Ok schema: #/definitions/outgoingDereEventOccurrence 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDereEventOccurrence 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/{parentId}/eventOccurrences: 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/outgoingDereEventOccurrence responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingDereEventOccurrence 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/outgoingDereEventOccurrence responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingDereEventOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventOccurrence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEvent/{parentId}/eventOccurrences/{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/editOutgoingDereEventOccurrence responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventOccurrence 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/outgoingDereEventOccurrence responses: 200: description: Ok schema: #/definitions/outgoingDereEventOccurrence 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/outgoingDereEventOccurrence 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 /issuer/entities/outgoingDereEventOccurrence/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDereEventOccurrence responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventHistory responses: 200: description: The created resource schema: #/definitions/outgoingDereEventHistory 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: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventHistory responses: 200: description: The created resource schema: #/definitions/outgoingDereEventHistory 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDereEventHistory responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventHistory 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDereEventHistory responses: 200: description: Ok schema: #/definitions/outgoingDereEventHistory 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDereEventHistory 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDereEventHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventHistoryDetails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingDereEventHistoryDetails 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: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingDereEventHistoryDetails 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventHistoryDetails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDereEventHistoryDetails responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventHistoryDetails 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDereEventHistoryDetails responses: 200: description: Ok schema: #/definitions/outgoingDereEventHistoryDetails 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDereEventHistoryDetails 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventHistory/{parentId}/historyDetails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingDereEventHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereEventHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingDereEventHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereEventHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereEventHistory/{parentId}/historyDetails/{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/editOutgoingDereEventHistoryDetails responses: 200: description: Ok schema: #/definitions/editOutgoingDereEventHistoryDetails 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/outgoingDereEventHistoryDetails responses: 200: description: Ok schema: #/definitions/outgoingDereEventHistoryDetails 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/outgoingDereEventHistoryDetails 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 /issuer/entities/outgoingDereEventHistoryDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDereEventHistoryDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereBatch: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereBatch responses: 200: description: The created resource schema: #/definitions/outgoingDereBatch 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: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDereBatch responses: 200: description: The created resource schema: #/definitions/outgoingDereBatch 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDereBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereBatch/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDereBatch responses: 200: description: Ok schema: #/definitions/editOutgoingDereBatch 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDereBatch responses: 200: description: Ok schema: #/definitions/outgoingDereBatch 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDereBatch 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereBatch/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDereBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereBatchEventLink: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dereBatchEventLink responses: 200: description: The created resource schema: #/definitions/dereBatchEventLink 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: entity in: body required: true schema: type: object allOf: – #/definitions/dereBatchEventLink responses: 200: description: The created resource schema: #/definitions/dereBatchEventLink 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dereBatchEventLink 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereBatchEventLink/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDereBatchEventLink responses: 200: description: Ok schema: #/definitions/editDereBatchEventLink 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dereBatchEventLink responses: 200: description: Ok schema: #/definitions/dereBatchEventLink 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dereBatchEventLink 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereBatch/{parentId}/batchEvents: 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/dereBatchEventLink responses: 200: description: The created resources schema: type: array items: #/definitions/dereBatchEventLink 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/dereBatchEventLink responses: 200: description: The created resources schema: type: array items: #/definitions/dereBatchEventLink 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dereBatchEventLink 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDereBatch/{parentId}/batchEvents/{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/editDereBatchEventLink responses: 200: description: Ok schema: #/definitions/editDereBatchEventLink 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/dereBatchEventLink responses: 200: description: Ok schema: #/definitions/dereBatchEventLink 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/dereBatchEventLink 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 /issuer/entities/dereBatchEventLink/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dereBatchEventLink responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereSchema: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dereSchema responses: 200: description: The created resource schema: #/definitions/dereSchema 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: entity in: body required: true schema: type: object allOf: – #/definitions/dereSchema responses: 200: description: The created resource schema: #/definitions/dereSchema 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dereSchema 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereSchema/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDereSchema responses: 200: description: Ok schema: #/definitions/editDereSchema 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dereSchema responses: 200: description: Ok schema: #/definitions/dereSchema 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dereSchema 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereSchema/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dereSchema responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereXsd: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dereXsd responses: 200: description: The created resource schema: #/definitions/dereXsd 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: entity in: body required: true schema: type: object allOf: – #/definitions/dereXsd responses: 200: description: The created resource schema: #/definitions/dereXsd 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dereXsd 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereXsd/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDereXsd responses: 200: description: Ok schema: #/definitions/editDereXsd 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dereXsd responses: 200: description: Ok schema: #/definitions/dereXsd 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dereXsd 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereSchema/{parentId}/xsds: 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/dereXsd responses: 200: description: The created resources schema: type: array items: #/definitions/dereXsd 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/dereXsd responses: 200: description: The created resources schema: type: array items: #/definitions/dereXsd 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dereXsd 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereSchema/{parentId}/xsds/{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/editDereXsd responses: 200: description: Ok schema: #/definitions/editDereXsd 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/dereXsd responses: 200: description: Ok schema: #/definitions/dereXsd 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/dereXsd 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 /issuer/entities/dereXsd/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dereXsd responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070empCertificate: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070empCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070empCertificate/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070empCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070filCertificate: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070filCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070filCertificate/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070filCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/integrationIssue: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/integrationIssue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereParameter: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dereParameter responses: 200: description: The created resource schema: #/definitions/dereParameter 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: entity in: body required: true schema: type: object allOf: – #/definitions/dereParameter responses: 200: description: The created resource schema: #/definitions/dereParameter 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: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/dereParameter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereParameter/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDereParameter responses: 200: description: Ok schema: #/definitions/editDereParameter 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: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dereParameter responses: 200: description: Ok schema: #/definitions/dereParameter 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: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dereParameter 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: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/dereParameter/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dereParameter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumDereEventSituation: type: string enum: – RECEIVED – IN_PROGRESS – AUTHORIZED – REJECTED – SERPRO_CONNECTION_FAILURE description: Situação do evento DeRE (visível em tela): * `RECEIVED` – Evento recebido * `IN_PROGRESS` – Evento em processamento * `AUTHORIZED` – Evento autorizado * `REJECTED` – Evento rejeitado * `SERPRO_CONNECTION_FAILURE` – Falha de conexão com a SERPRO enumDereProcessingStage: type: string enum: – WAITING_SIGN – SIGNED – SIGN_ERROR – BATCHED – SENT – AWAITING_QUERY_RESPONSE – SEND_TO_GATEWAY_PREPARATION_ERROR – PROCESSED – BATCH_NOT_RECEIVED – MANUALLY_REJECTED description: Estágio interno de processamento do evento DeRE: * `WAITING_SIGN` – Aguardando assinatura digital * `SIGNED` – Assinatura digital concluída * `SIGN_ERROR` – Erro na assinatura digital * `BATCHED` – Agrupado em lote para envio * `SENT` – Lote enviado ao gateway SEFAZ * `AWAITING_QUERY_RESPONSE` – Aguardando resposta do pooling de consulta de status do lote * `SEND_TO_GATEWAY_PREPARATION_ERROR` – Erro ao enviar lote para o gateway * `PROCESSED` – Processamento concluído pelo Ambiente Nacional (autorizado ou rejeitado via D-9001) * `BATCH_NOT_RECEIVED` – Lote não recebido pelo Ambiente Nacional * `MANUALLY_REJECTED` – Evento rejeitado manualmente pelo usuário enumDereEventType: type: string enum: – D_1001 – D_1011 – D_1021 – D_1101 – D_2501 – D_3501 – D_9001 – D_1106 – D_1121 – D_1198 – D_1199 – D_2101 – D_2102 description: Tipo de evento DeRE (D-*): * `D_1001` – D-1001 – Informações das Contribuições * `D_1011` – D-1011 – Informações das Contribuições por Estabelecimento * `D_1021` – D-1021 – Informações de Apuração do IBS * `D_1101` – D-1101 – Informações de Operações com Bens Imóveis * `D_2501` – D-2501 – Informações Complementares * `D_3501` – D-3501 – Informações de Eventos * `D_9001` – D-9001 – Consulta de Resultado de Processamento * `D_1106` – D-1106 – Identificação de Aplicações Financeiras * `D_1121` – D-1121 – Relação de Deduções Utilizadas na Apuração * `D_1198` – D-1198 – Reabertura de Período de Apuração * `D_1199` – D-1199 – Fechamento de Eventos Mensais * `D_2101` – D-2101 – Débito em Operações com Títulos de Dívida com Oferta Pública * `D_2102` – D-2102 – Identificação de Cotistas de Fundos de Investimento enumDereTpOper: type: string enum: – INCLUSION – ALTERATION – EXCLUSION description: Tipo de operação DeRE: * `INCLUSION` – Inclusão * `ALTERATION` – Alteração * `EXCLUSION` – Exclusão enumDereExclusionReason: type: string enum: – JUDICIAL_ADMINISTRATIVE – UNDUE_SUBMISSION – IDENTIFICATION_ERROR – OTHER description: Motivo da exclusão do evento DeRE: * `JUDICIAL_ADMINISTRATIVE` – Decisão Judicial ou Administrativa * `UNDUE_SUBMISSION` – Envio Indevido * `IDENTIFICATION_ERROR` – Erro de Identificação * `OTHER` – Outros enumDereRegime: type: string enum: – COMMON – FINANCIAL_SERVICES – HEALTH_PLANS – PROGNOSTIC_LOTTERY description: Regime tributário DeRE: * `COMMON` – Comum * `FINANCIAL_SERVICES` – Serviços Financeiros * `HEALTH_PLANS` – Planos de Saúde * `PROGNOSTIC_LOTTERY` – Prognóstico e Loteria enumDerePeriodicity: type: string enum: – EVENTUAL – MONTHLY – TRANSACTIONAL description: Periodicidade do evento DeRE: * `EVENTUAL` – Eventual * `MONTHLY` – Mensal * `TRANSACTIONAL` – Transacional enumDereCreationType: type: string enum: – INTEGRATION – MIGRATION description: Tipo de criação do evento DeRE: * `INTEGRATION` – Integração * `MIGRATION` – Migração enumDereOccurrenceType: type: string enum: – ERROR – WARNING description: Tipo de ocorrência do processamento DeRE: * `ERROR` – Erro * `WARNING` – Advertência enumDereBatchStatus: type: string enum: – PREPARING – SENT – WAITING_PROCESSING – PROCESSED_SUCCESS – PROCESSED_WITH_ERRORS – QUERY_NOT_EXECUTED – BATCH_NOT_FOUND – BATCH_NOT_RECEIVED – INTERNAL_ERROR description: Situação do lote de envio DeRE: * `PREPARING` – Lote em preparação * `SENT` – Lote enviado à API * `WAITING_PROCESSING` – Aguardando processamento (cdResposta=1) * `PROCESSED_SUCCESS` – Processado com sucesso (cdResposta=2) * `PROCESSED_WITH_ERRORS` – Processado com erros (cdResposta=3) * `QUERY_NOT_EXECUTED` – Consulta não executada (cdResposta=4) * `BATCH_NOT_FOUND` – Lote não encontrado (cdResposta=5) * `BATCH_NOT_RECEIVED` – Lote não recebido (cdResposta=7) * `INTERNAL_ERROR` – Erro interno (cdResposta=9) environmentType: type: string enum: – PROD – HOMOLOG description: Tipo de ambiente DeRE: * `PROD` – Produção * `HOMOLOG` – Homologação enumXmlType: type: string enum: – INTEGRATED – SIGNED – AUTHORIZED description: Tipo do XML armazenado: * `INTEGRATED` – XML integrado (recebido na origem) * `SIGNED` – XML assinado digitalmente * `AUTHORIZED` – XML autorizado (retorno SEFAZ) statusSign: type: string enum: – SUCCESS – SIGN_ERROR description: Status da assinatura digital: * `SUCCESS` – Assinatura concluída com sucesso * `SIGN_ERROR` – Erro durante a assinatura enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error integrationIssueXml: description: Dados do XML da crítica de integração no DynamoDB type: object required: – id – integratedXml – expirationDate properties: id: type: string description: Identificador da crítica de integração integratedXml: type: string description: XML integrado expirationDate: type: string format: date-time description: Data de expiração dereDownloadRecord: description: Record utilizado para solicitar o download do XML de um evento DeRE type: object properties: eventAccessKey: type: string description: Chave de acesso do evento DeRE (identificador único retornado pela API) xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML dereDownloadResponse: description: Record utilizado para retornar o XML de um evento DeRE type: object required: – eventId – eventAccessKey – xmlUrl properties: eventId: type: string description: Identificador único do evento eventAccessKey: type: string description: Chave de acesso do evento DeRE (identificador único retornado pela API) xmlUrl: type: string description: URL do XML do evento DeRE 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 dereReceiptOccurrence: description: Ocorrência de processamento do D-9001 type: object required: – cd – description – type properties: cd: type: string description: Código da ocorrência description: type: string description: Descrição da ocorrência type: type: string allOf: – #/definitions/enumDereOccurrenceType description: Tipo da ocorrência (ERROR ou WARNING) location: type: string description: Localização no XML dereParameterRecord: description: Parâmetro de DeRE type: object required: – code properties: code: type: string description: Chave do parâmetro value: type: string maxLength: 1000 description: Valor do parâmetro origin: type: string description: Origem do parâmetro outgoingDereEvent: description: Evento DeRE de saída (cabeçalho genérico para qualquer D-*) type: object required: – eventType – situation – tpOper – nrInsc – iniValid – environmentType – integrationDate – creationType properties: id: type: string format: uuid description: Identificador do evento e070fil: type: object allOf: – #/definitions/e070fil description: Filial emissora eventAccessKey: type: string description: Identificador único do evento (eventAccessKey da API DeRE) eventType: type: string allOf: – #/definitions/enumDereEventType description: Tipo do evento DeRE (D-1001, D-1011, etc) situation: type: string allOf: – #/definitions/enumDereEventSituation description: Situação do evento tpOper: type: string allOf: – #/definitions/enumDereTpOper description: Tipo de operação (inclusão, alteração, exclusão) nrInsc: type: string maxLength: 8 description: CNPJ Raiz do contribuinte (8 caracteres, alfanumérico) iniValid: type: string maxLength: 10 description: Início da validade (AAAA-MM-DD) fimValid: type: string maxLength: 10 description: Fim da validade (AAAA-MM-DD) regime: type: string allOf: – #/definitions/enumDereRegime description: Regime tributário periodicity: type: string allOf: – #/definitions/enumDerePeriodicity description: Periodicidade do evento exclusionReason: type: string allOf: – #/definitions/enumDereExclusionReason description: Motivo da exclusão environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente (Produção/Pré-Produção) nrRecibo: type: string description: Número do recibo de entrega do evento (infoRecEv/nrRecibo) batchProtocol: type: string description: Protocolo do lote em que o evento foi recebido pelo Ambiente Nacional processingDate: type: string format: date-time description: Data e hora de processamento authorizationDate: type: string format: date-time description: Data e hora de autorização integrationDate: type: string format: date-time description: Data e hora de integração/criação situationDate: type: string format: date-time description: Data de alteração da situação creationType: type: string allOf: – #/definitions/enumDereCreationType description: Tipo de criação do evento externalDocumentId: type: string description: Identificador do evento no ERP (referência externa) layoutVersion: type: string description: Versão do layout do evento eventHash: type: string description: Hash do evento para controle de integridade processingStage: type: string allOf: – #/definitions/enumDereProcessingStage description: Estágio interno de processamento processingAttempts: type: integer format: int64 description: Número de tentativas de processamento default: 0 eventXmls: type: array items: type: object allOf: – #/definitions/outgoingDereEventXml description: XMLs do evento eventRejection: type: object allOf: – #/definitions/outgoingDereEventRejection description: Rejeição do evento eventOccurrences: type: array items: type: object allOf: – #/definitions/outgoingDereEventOccurrence description: Ocorrências de processamento do evento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDereEvent: type: object required: – id allOf: – #/definitions/outgoingDereEvent outgoingDereEventXml: description: XML armazenado de um evento DeRE type: object required: – fileName – targetObjectId – version – xmlType properties: id: type: string format: uuid description: Identificador do XML outgoingDereEvent: type: object allOf: – #/definitions/outgoingDereEvent description: Evento DeRE ao qual pertence o XML fileName: type: string description: Nome do arquivo no storage targetObjectId: type: string description: Identificador do arquivo no blob service type: string description: Versão do arquivo xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML (integrado, assinado, autorizado) returnEventTag: type: string description: Nome da tag pai do evento de retorno (ex: evtRetornoTabela), preenchido no XML autorizado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDereEventXml: type: object required: – id allOf: – #/definitions/outgoingDereEventXml outgoingDereEventRejection: description: Mensagem de rejeição de um evento DeRE type: object required: – rejectionMessage – rejectionCode properties: id: type: string format: uuid description: Identificador da rejeição outgoingDereEvent: type: object allOf: – #/definitions/outgoingDereEvent description: Evento DeRE rejeitado rejectionMessage: type: string description: Mensagem de rejeição rejectionCode: type: string maxLength: 20 description: Código de rejeição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDereEventRejection: type: object required: – id allOf: – #/definitions/outgoingDereEventRejection outgoingDereEventOccurrence: description: Ocorrência de processamento de um evento DeRE (até 10 por D-9001) type: object required: – occurrenceType – occurrenceCode – occurrenceDescription properties: id: type: string format: uuid description: Identificador da ocorrência outgoingDereEvent: type: object allOf: – #/definitions/outgoingDereEvent description: Evento DeRE occurrenceType: type: string allOf: – #/definitions/enumDereOccurrenceType description: Tipo da ocorrência (erro/advertência) occurrenceCode: type: string maxLength: 10 description: Código da ocorrência occurrenceDescription: type: string description: Descrição da ocorrência xmlLocation: type: string description: Localização no XML (campo/tag) usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDereEventOccurrence: type: object required: – id allOf: – #/definitions/outgoingDereEventOccurrence outgoingDereEventHistory: description: Histórico de movimentações de um evento DeRE type: object required: – eventSituation – historyDateTime – firedBy properties: id: type: string format: uuid description: Identificador do histórico outgoingDereEvent: type: object allOf: – #/definitions/outgoingDereEvent description: Evento DeRE eventSituation: type: string allOf: – #/definitions/enumDereEventSituation description: Situação do evento no momento do histórico historyDateTime: type: string format: date-time description: Data e hora da movimentação firedBy: type: string description: Usuário que disparou a ação historyOccurrence: type: string description: Ocorrência do histórico (descrição livre) historyDetails: type: object allOf: – #/definitions/outgoingDereEventHistoryDetails description: Detalhes do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDereEventHistory: type: object required: – id allOf: – #/definitions/outgoingDereEventHistory outgoingDereEventHistoryDetails: description: Detalhes do histórico de um evento DeRE type: object required: – message – code properties: id: type: string format: uuid description: Identificador dos detalhes eventHistory: type: object allOf: – #/definitions/outgoingDereEventHistory description: Histórico do evento message: type: string maxLength: 255 description: Mensagem do detalhe code: type: string maxLength: 10 description: Código do detalhe usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDereEventHistoryDetails: type: object required: – id allOf: – #/definitions/outgoingDereEventHistoryDetails outgoingDereBatch: description: Lote de envio DeRE (agrupa eventos para transmissão à API, limite 50) type: object required: – nrInsc – niTransmissor – batchStatus – environmentType – creationDate – eventCount properties: id: type: string format: uuid description: Identificador do lote nrInsc: type: string maxLength: 14 description: CNPJ Raiz do contribuinte (inscrito, 14 chars alfanumérico) niTransmissor: type: string maxLength: 14 description: Número de inscrição do transmissor (procurador ou próprio, 14 chars alfanumérico) batchStatus: type: string allOf: – #/definitions/enumDereBatchStatus description: Situação do lote batchProtocol: type: string description: Protocolo do lote (retornado na transmissão) environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente creationDate: type: string format: date-time description: Data e hora de criação do lote sendDate: type: string format: date-time description: Data e hora de envio do lote lastQueryDate: type: string format: date-time description: Data e hora da última consulta de resultado eventCount: type: integer format: int64 description: Quantidade de eventos no lote (máximo 50) responseCode: type: integer format: int64 description: Código de resposta do processamento (1 a 9) responseMessage: type: string description: Mensagem de resposta do processamento sendAttempts: type: integer format: int64 description: Número de tentativas de envio nextRetryAt: type: string format: date-time description: Data e hora da próxima tentativa de envio (backoff) batchEvents: type: array items: type: object allOf: – #/definitions/dereBatchEventLink description: Eventos do lote usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDereBatch: type: object required: – id allOf: – #/definitions/outgoingDereBatch dereBatchEventLink: description: Associação N-N entre lote e eventos DeRE type: object required: – position properties: id: type: string format: uuid description: Identificador outgoingDereBatch: type: object allOf: – #/definitions/outgoingDereBatch description: Lote de envio outgoingDereEvent: type: object allOf: – #/definitions/outgoingDereEvent description: Evento DeRE position: type: integer format: int64 description: Posição do evento dentro do lote (1 a 50) usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDereBatchEventLink: type: object required: – id allOf: – #/definitions/dereBatchEventLink dereSchema: description: Schema XSD de um tipo de evento DeRE type: object required: – eventType – schemaVersion – validFrom – environmentType properties: id: type: string format: uuid description: Identificador do schema eventType: type: string allOf: – #/definitions/enumDereEventType description: Tipo do evento DeRE associado schemaVersion: type: string description: Versão do schema validFrom: type: string format: date description: Data de início de vigência validTo: type: string format: date description: Data de fim de vigência environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente xsds: type: array items: type: object allOf: – #/definitions/dereXsd description: XSDs vinculados a este schema usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDereSchema: type: object required: – id allOf: – #/definitions/dereSchema dereXsd: description: Arquivo XSD individual de um schema DeRE type: object required: – fileName – targetObjectId – version properties: id: type: string format: uuid description: Identificador do XSD dereSchema: type: object allOf: – #/definitions/dereSchema description: Schema ao qual pertence fileName: type: string description: Nome do arquivo XSD targetObjectId: type: string description: Identificador do arquivo no blob service type: string description: Versão do arquivo namespace: type: string description: Namespace do XSD mainSchema: type: boolean description: Indica se é o XSD principal (raiz) default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDereXsd: type: object required: – id allOf: – #/definitions/dereXsd e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação e070empCertificate: type: object allOf: – #/definitions/e070empCertificate description: Certificado eDocs X usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa numCgc: type: string maxLength: 18 description: CPF/CNPJ excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação e070filCertificate: type: object allOf: – #/definitions/e070filCertificate description: Certificado eDocs X usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070empCertificate: description: Certificado de eDocs X para Empresa type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa fileName: type: string description: Nome do arquivo targetObjectId: type: string description: Id do arquivo type: string description: Versão do arquivo expirationDate: type: string format: date-time description: Data de validade subject: type: string description: Nome do certificado issuedBy: type: string description: Certificado emitido por issuedTo: type: string description: Certificado emitido para privateKey: type: boolean description: Chave privada password: type: string description: Senha do certificado validCertificateChain: type: boolean description: Cadeia de certificados válida extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação excluido: type: boolean description: Indica se o registro foi excluído default: false fileNameExt: type: string description: Nome do arquivo extendido targetObjectIdExt: type: string description: Id do arquivo extendido versionExt: type: string description: Versão do arquivo extendido usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filCertificate: description: Certificado de eDocs X para Filial type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial fileName: type: string description: Nome do arquivo targetObjectId: type: string description: Id do arquivo type: string description: Versão do arquivo expirationDate: type: string format: date-time description: Data de validade subject: type: string description: Nome do certificado issuedBy: type: string description: Certificado emitido por issuedTo: type: string description: Certificado emitido para privateKey: type: boolean description: Chave privada password: type: string description: Senha do certificado validCertificateChain: type: boolean description: Cadeia de certificados válida extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação excluido: type: boolean description: Indica se o registro foi excluído default: false fileNameExt: type: string description: Nome do arquivo extendido targetObjectIdExt: type: string description: Id do arquivo extendido versionExt: type: string description: Versão do arquivo extendido usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: integrationIssue: description: Críticas de integração type: object properties: id: type: string format: uuid description: Identificador da crítica de integração requisitionId: type: string description: Chave informada na requisição issue: type: string description: Mensagem da crítica de integração issueDateTime: type: string format: date-time description: Data e hora da crítica de integração eventType: type: string allOf: – #/definitions/enumDereEventType description: Tipo do evento que gerou a crítica usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: dereParameter: description: Parâmetros do serviço DeRE type: object required: – e070emp – code – value properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial (opcional – quando informada, sobrepõe o parâmetro da empresa) code: type: string description: Código do parâmetro value: type: string maxLength: 1000 description: Valor do parâmetro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDereParameter: type: object required: – id allOf: – #/definitions/dereParameter notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação