2.0info: 1.9.0 eventos_fiscais x-senior-domain: erpx_cpl_dfe x-senior-domain-path: erpx_cpl_dfe x-senior-service-path: eventos_fiscais contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_cpl_dfesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /eventos_fiscais/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 /eventos_fiscais/queries/eventoFiscalListar: post: description: API para listar os eventos fiscais conforme filtro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – offset – size properties: filter: type: object allOf: – #/definitions/recEventosFiscaisListar description: Filtro listagem de eventos fiscais offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade de registros por página sort: type: array items: type: object allOf: – #/definitions/fieldsBySort description: Ordenação responses: 200: description: Ok schema: type: object required: – eventos properties: eventos: type: array items: type: object allOf: – #/definitions/recEventoFiscalItem minimum: 1 description: Lista de eventos fiscais totalPages: type: integer format: int64 description: Pages totalElements: type: integer format: int64 description: Total page: type: integer format: int64 description: Número da página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/queries/eventoFiscalReabilitar: post: description: API para reabilitar um evento fiscal, colocando-o na situação DIGITADA tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dfeEventosId properties: dfeEventosId: type: string description: Identificação única do evento responses: 200: description: Ok schema: type: object required: – dfeEventosId – sucesso – mensagem properties: dfeEventosId: type: string description: Identificação única do evento reabilitado sucesso: type: boolean description: Status da operação mensagem: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API para reabilitar um evento fiscal, colocando-o na situação DIGITADA tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dfeEventosId description: Identificação única do evento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dfeEventosId – sucesso – mensagem properties: dfeEventosId: type: string description: Identificação única do evento reabilitado sucesso: type: boolean description: Status da operação mensagem: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/queries/tiposEventosDisponiveis: post: description: API para listar os tipos de eventos disponíveis para cadastro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – eventos properties: eventos: type: array items: type: object allOf: – #/definitions/recTipoEventoDisponivel minimum: 1 description: Lista de tipos de eventos disponíveis para cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API para listar os tipos de eventos disponíveis para cadastro tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – eventos properties: eventos: type: array items: type: object allOf: – #/definitions/recTipoEventoDisponivel minimum: 1 description: Lista de tipos de eventos disponíveis para cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/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 /eventos_fiscais/queries/exportDfeEvento: 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 /eventos_fiscais/queries/exportDfeEventoDetalhe: 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 /eventos_fiscais/queries/exportDfeEventoCancelado: 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 /eventos_fiscais/queries/exportDfeEventoProcesso: 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 /eventos_fiscais/queries/exportDfeEventoProcessoErro: 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 /eventos_fiscais/queries/exportDfeEventoProcessoRetorno: 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 /eventos_fiscais/queries/exportDfeItemDetalhesPerecimentoEmitente: 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 /eventos_fiscais/queries/exportDfeItemDetalhesConsumoImp: 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 /eventos_fiscais/queries/exportDfeItemDetalhesPerecimentoDestinatario: 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 /eventos_fiscais/queries/exportE015med: 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 /eventos_fiscais/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 /eventos_fiscais/queries/exportE031moe: 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 /eventos_fiscais/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 /eventos_fiscais/queries/exportE008rai: 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 /eventos_fiscais/queries/exportE007ufs: 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 /eventos_fiscais/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 /eventos_fiscais/actions/enviarEventoFiscal: post: description: API para enviar um evento fiscal ja salvo para processamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dfeEventosId properties: dfeEventosId: type: string description: Identificação única do evento a enviar responses: 200: description: Ok schema: type: object required: – dfeEventosId – sucesso – mensagem properties: dfeEventosId: type: string description: Identificação única do evento enviado sucesso: type: boolean description: Status da operação mensagem: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/actions/eventoFiscalReprocessar: post: description: API para reprocessar o evento fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dfeEventosId properties: dfeEventosId: type: string description: Identificação única do evento responses: 200: description: Ok schema: type: object required: – dfeEventosId – sucesso – mensagem properties: dfeEventosId: type: string description: Identificação única do evento reprocessado sucesso: type: boolean description: Status da operação mensagem: type: string description: Mensagem de retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/actions/eventoFiscalPrepararCancelamento: post: description: Permite preparar o evento para fazer o cancelamento do mesmo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dfeEventosId properties: dfeEventosId: type: array items: type: string minimum: 1 description: Identificação única dos eventos a serem cancelados responses: 200: description: Ok schema: type: object required: – eventosCancelamentoIds properties: eventosCancelamentoIds: type: array items: type: string minimum: 1 description: Identificações dos eventos de cancelamento criados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/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 /eventos_fiscais/actions/importDfeEvento: 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 /eventos_fiscais/actions/importDfeEventoDetalhe: 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 /eventos_fiscais/actions/importDfeEventoCancelado: 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 /eventos_fiscais/actions/importDfeEventoProcesso: 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 /eventos_fiscais/actions/importDfeEventoProcessoErro: 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 /eventos_fiscais/actions/importDfeEventoProcessoRetorno: 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 /eventos_fiscais/actions/importDfeItemDetalhesPerecimentoEmitente: 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 /eventos_fiscais/actions/importDfeItemDetalhesConsumoImp: 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 /eventos_fiscais/actions/importDfeItemDetalhesPerecimentoDestinatario: 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 /eventos_fiscais/actions/importE015med: 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 /eventos_fiscais/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 /eventos_fiscais/actions/importE031moe: 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 /eventos_fiscais/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 /eventos_fiscais/actions/importE008rai: 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 /eventos_fiscais/actions/importE007ufs: 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 /eventos_fiscais/events/eventoFiscalDisponivelParaEnvio: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – dfeEventoId properties: dfeEventoId: type: string description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /eventos_fiscais/events/eventoFiscalStatus: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – dfeEventoId – status – statusEletronico – dthalt properties: dfeEventoId: type: string description: status: type: string allOf: – #/definitions/enumEventoStatus description: statusEletronico: type: string allOf: – #/definitions/enumStatusEletronico description: dthalt: type: string format: date-time description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /eventos_fiscais/events/importDfeEventoEvent: 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 /eventos_fiscais/events/exportDfeEventoEvent: 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 /eventos_fiscais/events/importDfeEventoDetalheEvent: 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 /eventos_fiscais/events/exportDfeEventoDetalheEvent: 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 /eventos_fiscais/events/importDfeEventoCanceladoEvent: 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 /eventos_fiscais/events/exportDfeEventoCanceladoEvent: 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 /eventos_fiscais/events/importDfeEventoProcessoEvent: 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 /eventos_fiscais/events/exportDfeEventoProcessoEvent: 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 /eventos_fiscais/events/importDfeEventoProcessoErroEvent: 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 /eventos_fiscais/events/exportDfeEventoProcessoErroEvent: 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 /eventos_fiscais/events/importDfeEventoProcessoRetornoEvent: 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 /eventos_fiscais/events/exportDfeEventoProcessoRetornoEvent: 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 /eventos_fiscais/events/importDfeItemDetalhesPerecimentoEmitenteEvent: 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 /eventos_fiscais/events/exportDfeItemDetalhesPerecimentoEmitenteEvent: 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 /eventos_fiscais/events/importDfeItemDetalhesConsumoImpEvent: 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 /eventos_fiscais/events/exportDfeItemDetalhesConsumoImpEvent: 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 /eventos_fiscais/events/importDfeItemDetalhesPerecimentoDestinatarioEvent: 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 /eventos_fiscais/events/exportDfeItemDetalhesPerecimentoDestinatarioEvent: 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 /eventos_fiscais/events/importE015medEvent: 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 /eventos_fiscais/events/exportE015medEvent: 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 /eventos_fiscais/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 /eventos_fiscais/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 /eventos_fiscais/events/importE031moeEvent: 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 /eventos_fiscais/events/exportE031moeEvent: 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 /eventos_fiscais/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 /eventos_fiscais/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 /eventos_fiscais/events/importE008raiEvent: 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 /eventos_fiscais/events/exportE008raiEvent: 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 /eventos_fiscais/events/importE007ufsEvent: 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 /eventos_fiscais/events/exportE007ufsEvent: 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 /eventos_fiscais/entities/dfeEvento: 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/dfeEvento responses: 200: description: The created resource schema: #/definitions/dfeEvento 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/dfeEvento responses: 200: description: The created resource schema: #/definitions/dfeEvento 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/dfeEvento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEvento/{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/editDfeEvento responses: 200: description: Ok schema: #/definitions/editDfeEvento 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/dfeEvento responses: 200: description: Ok schema: #/definitions/dfeEvento 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/dfeEvento 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 /eventos_fiscais/entities/dfeEvento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeEvento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoDetalhe: 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/dfeEventoDetalhe responses: 200: description: The created resource schema: #/definitions/dfeEventoDetalhe 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/dfeEventoDetalhe responses: 200: description: The created resource schema: #/definitions/dfeEventoDetalhe 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/dfeEventoDetalhe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoDetalhe/{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/editDfeEventoDetalhe responses: 200: description: Ok schema: #/definitions/editDfeEventoDetalhe 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/dfeEventoDetalhe responses: 200: description: Ok schema: #/definitions/dfeEventoDetalhe 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/dfeEventoDetalhe 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 /eventos_fiscais/entities/dfeEvento/{parentId}/dfeEventoDetalhe: 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/dfeEventoDetalhe responses: 200: description: The created resource schema: #/definitions/dfeEventoDetalhe 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/dfeEventoDetalhe responses: 200: description: The created resource schema: #/definitions/dfeEventoDetalhe 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/dfeEventoDetalhe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEvento/{parentId}/dfeEventoDetalhe/{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/editDfeEventoDetalhe responses: 200: description: Ok schema: #/definitions/editDfeEventoDetalhe 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/dfeEventoDetalhe responses: 200: description: Ok schema: #/definitions/dfeEventoDetalhe 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/dfeEventoDetalhe 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 /eventos_fiscais/entities/dfeEventoDetalhe/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeEventoDetalhe responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoCancelado: 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/dfeEventoCancelado responses: 200: description: The created resource schema: #/definitions/dfeEventoCancelado 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/dfeEventoCancelado responses: 200: description: The created resource schema: #/definitions/dfeEventoCancelado 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/dfeEventoCancelado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoCancelado/{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/editDfeEventoCancelado responses: 200: description: Ok schema: #/definitions/editDfeEventoCancelado 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/dfeEventoCancelado responses: 200: description: Ok schema: #/definitions/dfeEventoCancelado 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/dfeEventoCancelado 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 /eventos_fiscais/entities/dfeEventoDetalhe/{parentId}/dfeEventoCancelado: 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/dfeEventoCancelado responses: 200: description: The created resource schema: #/definitions/dfeEventoCancelado 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/dfeEventoCancelado responses: 200: description: The created resource schema: #/definitions/dfeEventoCancelado 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/dfeEventoCancelado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoDetalhe/{parentId}/dfeEventoCancelado/{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/editDfeEventoCancelado responses: 200: description: Ok schema: #/definitions/editDfeEventoCancelado 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/dfeEventoCancelado responses: 200: description: Ok schema: #/definitions/dfeEventoCancelado 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/dfeEventoCancelado 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 /eventos_fiscais/entities/dfeEventoCancelado/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeEventoCancelado responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcesso: 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/dfeEventoProcesso responses: 200: description: The created resource schema: #/definitions/dfeEventoProcesso 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/dfeEventoProcesso responses: 200: description: The created resource schema: #/definitions/dfeEventoProcesso 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/dfeEventoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcesso/{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/editDfeEventoProcesso responses: 200: description: Ok schema: #/definitions/editDfeEventoProcesso 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/dfeEventoProcesso responses: 200: description: Ok schema: #/definitions/dfeEventoProcesso 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/dfeEventoProcesso 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 /eventos_fiscais/entities/dfeEvento/{parentId}/dfeEventoProcesso: 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/dfeEventoProcesso responses: 200: description: The created resources schema: type: array items: #/definitions/dfeEventoProcesso 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/dfeEventoProcesso responses: 200: description: The created resources schema: type: array items: #/definitions/dfeEventoProcesso 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/dfeEventoProcesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEvento/{parentId}/dfeEventoProcesso/{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/editDfeEventoProcesso responses: 200: description: Ok schema: #/definitions/editDfeEventoProcesso 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/dfeEventoProcesso responses: 200: description: Ok schema: #/definitions/dfeEventoProcesso 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/dfeEventoProcesso 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 /eventos_fiscais/entities/dfeEventoProcesso/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeEventoProcesso responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcessoErro: 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/dfeEventoProcessoErro responses: 200: description: The created resource schema: #/definitions/dfeEventoProcessoErro 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/dfeEventoProcessoErro responses: 200: description: The created resource schema: #/definitions/dfeEventoProcessoErro 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/dfeEventoProcessoErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcessoErro/{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/editDfeEventoProcessoErro responses: 200: description: Ok schema: #/definitions/editDfeEventoProcessoErro 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/dfeEventoProcessoErro responses: 200: description: Ok schema: #/definitions/dfeEventoProcessoErro 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/dfeEventoProcessoErro 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 /eventos_fiscais/entities/dfeEventoProcesso/{parentId}/dfeEventoProcessoErro: 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/dfeEventoProcessoErro responses: 200: description: The created resources schema: type: array items: #/definitions/dfeEventoProcessoErro 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/dfeEventoProcessoErro responses: 200: description: The created resources schema: type: array items: #/definitions/dfeEventoProcessoErro 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/dfeEventoProcessoErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcesso/{parentId}/dfeEventoProcessoErro/{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/editDfeEventoProcessoErro responses: 200: description: Ok schema: #/definitions/editDfeEventoProcessoErro 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/dfeEventoProcessoErro responses: 200: description: Ok schema: #/definitions/dfeEventoProcessoErro 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/dfeEventoProcessoErro 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 /eventos_fiscais/entities/dfeEventoProcessoErro/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeEventoProcessoErro responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcessoRetorno: 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/dfeEventoProcessoRetorno responses: 200: description: The created resource schema: #/definitions/dfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno responses: 200: description: The created resource schema: #/definitions/dfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcessoRetorno/{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/editDfeEventoProcessoRetorno responses: 200: description: Ok schema: #/definitions/editDfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno responses: 200: description: Ok schema: #/definitions/dfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno 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 /eventos_fiscais/entities/dfeEventoProcesso/{parentId}/dfeEventoProcessoRetorno: 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/dfeEventoProcessoRetorno responses: 200: description: The created resources schema: type: array items: #/definitions/dfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno responses: 200: description: The created resources schema: type: array items: #/definitions/dfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeEventoProcesso/{parentId}/dfeEventoProcessoRetorno/{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/editDfeEventoProcessoRetorno responses: 200: description: Ok schema: #/definitions/editDfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno responses: 200: description: Ok schema: #/definitions/dfeEventoProcessoRetorno 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/dfeEventoProcessoRetorno 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 /eventos_fiscais/entities/dfeEventoProcessoRetorno/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeEventoProcessoRetorno responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeItemDetalhesPerecimentoEmitente: 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/dfeItemDetalhesPerecimentoEmitente responses: 200: description: The created resource schema: #/definitions/dfeItemDetalhesPerecimentoEmitente 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/dfeItemDetalhesPerecimentoEmitente responses: 200: description: The created resource schema: #/definitions/dfeItemDetalhesPerecimentoEmitente 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/dfeItemDetalhesPerecimentoEmitente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeItemDetalhesPerecimentoEmitente/{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/editDfeItemDetalhesPerecimentoEmitente responses: 200: description: Ok schema: #/definitions/editDfeItemDetalhesPerecimentoEmitente 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/dfeItemDetalhesPerecimentoEmitente responses: 200: description: Ok schema: #/definitions/dfeItemDetalhesPerecimentoEmitente 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/dfeItemDetalhesPerecimentoEmitente 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 /eventos_fiscais/entities/dfeItemDetalhesPerecimentoEmitente/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeItemDetalhesPerecimentoEmitente responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeItemDetalhesConsumoImp: 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/dfeItemDetalhesConsumoImp responses: 200: description: The created resource schema: #/definitions/dfeItemDetalhesConsumoImp 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/dfeItemDetalhesConsumoImp responses: 200: description: The created resource schema: #/definitions/dfeItemDetalhesConsumoImp 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/dfeItemDetalhesConsumoImp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeItemDetalhesConsumoImp/{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/editDfeItemDetalhesConsumoImp responses: 200: description: Ok schema: #/definitions/editDfeItemDetalhesConsumoImp 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/dfeItemDetalhesConsumoImp responses: 200: description: Ok schema: #/definitions/dfeItemDetalhesConsumoImp 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/dfeItemDetalhesConsumoImp 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 /eventos_fiscais/entities/dfeItemDetalhesConsumoImp/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeItemDetalhesConsumoImp responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeItemDetalhesPerecimentoDestinatario: 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/dfeItemDetalhesPerecimentoDestinatario responses: 200: description: The created resource schema: #/definitions/dfeItemDetalhesPerecimentoDestinatario 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/dfeItemDetalhesPerecimentoDestinatario responses: 200: description: The created resource schema: #/definitions/dfeItemDetalhesPerecimentoDestinatario 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/dfeItemDetalhesPerecimentoDestinatario 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/dfeItemDetalhesPerecimentoDestinatario/{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/editDfeItemDetalhesPerecimentoDestinatario responses: 200: description: Ok schema: #/definitions/editDfeItemDetalhesPerecimentoDestinatario 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/dfeItemDetalhesPerecimentoDestinatario responses: 200: description: Ok schema: #/definitions/dfeItemDetalhesPerecimentoDestinatario 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/dfeItemDetalhesPerecimentoDestinatario 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 /eventos_fiscais/entities/dfeItemDetalhesPerecimentoDestinatario/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dfeItemDetalhesPerecimentoDestinatario responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/e015med: 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/e015med 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/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 /eventos_fiscais/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 /eventos_fiscais/entities/e008rai: 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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /eventos_fiscais/entities/e007ufs: 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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumEventoOperacao: type: string enum: – SALVAR_ENVIAR – SALVAR description: Determina o que deve fazer ao gravar o evento: * `SALVAR_ENVIAR` – Salvar e enviar * `SALVAR` – Salvar enumEventoStatus: type: string enum: – DIGITADA – PROCESSANDO – ERRO – PROCESSADO description: Status do evento DIGITADA, PROCESSANDO, ERRO, PROCESSADO: * `DIGITADA` – Digitada * `PROCESSANDO` – Processando * `ERRO` – Erro * `PROCESSADO` – Processado enumTipoEvento: type: string enum: – EMITENTE_112110 – EMITENTE_112120 – EMITENTE_112130 – CANCELAMENTO_110001 – DESTINATARIO_211124 description: Tipo de eventos emitidos: * `EMITENTE_112110` – Emitente – 112110 – Informação de efetivo pagamento integral para liberar crédito presumido do adquirente * `EMITENTE_112120` – Emitente – 112120 – Importação em ALC/ZFM não convertida em isenção * `EMITENTE_112130` – Emitente – 112130 – Perecimento, perda, roubo ou furto durante o transporte contratado pelo fornecedor * `CANCELAMENTO_110001` – Cancelamento – 110001 – Cancelamento de evento fiscal * `DESTINATARIO_211124` – Destinatário – 211124 – Perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente enumStatusEletronico: type: string enum: – EM_PREPARACAO – AGUARDANDO_PROCESSAMENTO – ENVIADO – AUTORIZADO – ERRO – REJEITADO description: Status eletrônico do evento: * `EM_PREPARACAO` – Em preparação * `AGUARDANDO_PROCESSAMENTO` – Aguardando processamento * `ENVIADO` – Enviado * `AUTORIZADO` – Autorizado * `ERRO` – Erro * `REJEITADO` – Rejeitado enumTipoAutor: type: string enum: – EMPRESA_EMITENTE – EMPRESA_DESTINATARIA – EMPRESA – FISCO – RFB – OUTROS_ORGAOS description: Tipo do autor do evento: * `EMPRESA_EMITENTE` – 1 Empresa Emitente * `EMPRESA_DESTINATARIA` – 2 Empresa destinatária * `EMPRESA` – 3 Empresa * `FISCO` – 5 Fisco * `RFB` – 6 RFB * `OUTROS_ORGAOS` – 9 Outros Órgãos enumTipoProcesso: type: string enum: – MANUAL description: Tipo do processo: * `MANUAL` – Manual enumTipoDocumento: type: string enum: – V1 – V2 – V3 – V5 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 description: Tipo de documento – eDocs: * `V1` – Nota Fiscal de Produto * `V2` – Nota Fiscal de serviço * `V3` – Conhecimento de Transporte * `V5` – Manifesto eletrônico de Documentos Fiscais * `V7` – eSocial * `V8` – Nota Fiscal de Consumidor Eletrônica * `V9` – Cupom fiscal eletrônico * `V10` – EFD-Reinf * `V11` – GNRE * `V12` – Conhecimento de Transporte Outros serviços * `V13` – PAF-ECF Bloco X * `V14` – GRFGTS * `V15` – Evento de Encerramento do Manifesto eletrônico de Documentos Fiscais * `V16` – Evento de Cancelamento do Manifesto eletrônico de Documentos Fiscais * `V17` – Evento de Inclusão de Motorista no Manifesto eletrônico de Documentos Fiscais * `V18` – Evento de Inclusão de DF-e no Manifesto eletrônico de Documentos Fiscais 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 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 recEventoFiscalItem: description: Item da lista de eventos fiscais type: object required: – dfeEventosId – tpEvento – status – statusEletronico – detalhes – dthalt properties: dfeEventosId: type: string description: Identificação única do evento e070emp: type: object allOf: – #/definitions/e070emp description: Identificação única da empresa e070fil: type: object allOf: – #/definitions/e070fil description: Identificação única da filial cnpjCpf: type: string description: CNPJ/CPF chNFe: type: string description: Chave eletrônica da nota fiscal dhEvento: type: string format: date-time description: Data e hora do evento fiscal tpEvento: type: string allOf: – #/definitions/enumTipoEvento description: Tipo de evento a ser gerado status: type: string allOf: – #/definitions/enumEventoStatus description: Status do evento statusEletronico: type: string allOf: – #/definitions/enumStatusEletronico description: Status eletrônico do evento detalhes: type: object allOf: – #/definitions/dfeEventoDetalhe description: Detalhes do evento dthalt: type: string format: date-time description: Data e hora da última alteração recDetalhesEvento: description: Detalhes do evento type: object required: – descricaoEvento properties: descricaoEvento: type: string description: Descrição do evento recEventosFiscaisListar: description: type: object properties: e070empId: type: string description: Identificação única da empresa e070filId: type: array items: type: string description: Identificação única da filial cnpj: type: string description: CNPJ cpf: type: string description: CPF chNFe: type: array items: type: string description: Chave eletrônica da nota fiscal dhEventoInicial: type: string format: date-time description: Periodo inicial do evento fiscal dhEventoFinal: type: string format: date-time description: Periodo final do evento fiscal tpEvento: type: array items: type: string allOf: – #/definitions/enumTipoEvento description: Tipo de evento a ser gerado statusEvento: type: array items: type: string allOf: – #/definitions/enumEventoStatus description: Status do evento statusEletronico: type: array items: type: string allOf: – #/definitions/enumStatusEletronico description: Status eletrônico do evento numItem: type: integer format: int64 description: Número do item para filtrar (detalhes de perecimento) recTipoEventoDisponivel: description: Registro de tipo de evento disponível type: object required: – codigo – descricao properties: codigo: type: string allOf: – #/definitions/enumTipoEvento description: Código do tipo de evento descricao: type: string description: Descrição do tipo de evento fieldsBySort: description: Campos requeridos para ordenação no frontend type: object properties: field: type: string description: Campo order: type: integer format: int64 description: Ordenação dfeEvento: description: Evento fiscal DFe type: object required: – numNota – serie – tipoDocumento – tipoEvento properties: id: type: string format: uuid description: Identificação única do registro e070fil: type: object allOf: – #/definitions/e070fil description: Identificação única da filial cnpj: type: string description: CNPJ cpf: type: string description: CPF chNFe: type: string description: Chave eletrônica da nota fiscal numNota: type: integer format: int64 description: Número da nota serie: type: string maxLength: 20 description: Série da nota tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do documento dhEvento: type: string format: date-time description: Data e hora do evento tipoEvento: type: string allOf: – #/definitions/enumTipoEvento description: Tipo de evento status: type: string allOf: – #/definitions/enumEventoStatus description: Status do evento statusEletronico: type: string allOf: – #/definitions/enumStatusEletronico description: Status eletrônico do evento dfeEventoDetalhe: type: object allOf: – #/definitions/dfeEventoDetalhe description: Relacionamento com detalhes do evento dfeEventoProcesso: type: array items: type: object allOf: – #/definitions/dfeEventoProcesso description: Relacionamento com processos do evento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeEvento: type: object required: – id allOf: – #/definitions/dfeEvento dfeEventoDetalhe: description: Detalhes do evento fiscal DFe type: object required: – codigoOrgaoAutor – tipoAutor – versaoAplicada properties: id: type: string format: uuid description: Identificação única do registro dfeEvento: type: object allOf: – #/definitions/dfeEvento description: Identificação única do evento descricaoEvento: type: string description: Descrição do evento codigoOrgaoAutor: type: string description: Código do Órgão Autor do Evento tipoAutor: type: string allOf: – #/definitions/enumTipoAutor description: Tipo do autor versaoAplicada: type: string description: Versão aplicada numSeqEvento: type: integer format: int64 description: Número sequencial do evento indQuitacao: type: string description: Indicador de efetiva quitação dfeEventoCancelado: type: object allOf: – #/definitions/dfeEventoCancelado description: Cancelado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeEventoDetalhe: type: object required: – id allOf: – #/definitions/dfeEventoDetalhe dfeEventoCancelado: description: Entidade filha para dados específicos do cancelamento de eventos fiscais type: object properties: id: type: string format: uuid description: Identificação única do evento cancelado dfeEventoDetalhe: type: object allOf: – #/definitions/dfeEventoDetalhe description: Detalhes referenciado dfeEventoOrigem: type: object allOf: – #/definitions/dfeEvento description: Evento de origem tipoEventoAutorizado: type: string allOf: – #/definitions/enumTipoEvento description: Tipo de evento a ser cancelado numSeqEvento: type: integer format: int64 description: Número sequencial do evento a ser cancelado numProtocoloEvento: type: string description: Número do protocolo do evento a ser cancelado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeEventoCancelado: type: object required: – id allOf: – #/definitions/dfeEventoCancelado dfeEventoProcesso: description: type: object required: – tipoProcesso – status properties: id: type: string format: uuid description: Identificação única do registro dfeEvento: type: object allOf: – #/definitions/dfeEvento description: Identificação única do evento tipoProcesso: type: string allOf: – #/definitions/enumTipoProcesso description: Tipo do processo status: type: string allOf: – #/definitions/enumStatusEletronico description: status do processo dfeEventoProcessoErro: type: array items: type: object allOf: – #/definitions/dfeEventoProcessoErro description: Erros do processo dfeEventoProcessoRetorno: type: array items: type: object allOf: – #/definitions/dfeEventoProcessoRetorno description: Retorno do processo usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeEventoProcesso: type: object required: – id allOf: – #/definitions/dfeEventoProcesso dfeEventoProcessoErro: description: type: object required: – mensagem properties: id: type: string format: uuid description: Identificação única do erro dfeEventoProcesso: type: object allOf: – #/definitions/dfeEventoProcesso description: Evento Processo codigo: type: string maxLength: 50 description: Código do erro mensagem: type: string description: Mensagem do erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeEventoProcessoErro: type: object required: – id allOf: – #/definitions/dfeEventoProcessoErro dfeEventoProcessoRetorno: description: type: object required: – dataAutorizacao properties: id: type: string format: uuid description: Identificação única do erro dfeEventoProcesso: type: object allOf: – #/definitions/dfeEventoProcesso description: Evento Processo numeroProtocolo: type: string maxLength: 30 description: Numero do protocolo dataAutorizacao: type: string format: date-time description: Data de autorização usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeEventoProcessoRetorno: type: object required: – id allOf: – #/definitions/dfeEventoProcessoRetorno dfeItemDetalhesPerecimentoEmitente: description: Perecimento, perda, roubo ou furto durante o transporte (112130) type: object required: – dfeEventoDetalhe – numItem – qtdePerecimento – e015med properties: id: type: string format: uuid description: Identificação única do registro dfeEventoDetalhe: type: object allOf: – #/definitions/dfeEventoDetalhe description: Detalhes do evento (relação 1:N) numItem: type: integer format: int64 description: Número do item – Corresponde ao elemento det da nota valorIBS: type: string description: Valor do IBS na nota de fornecimento minimum: 0.00 maximum: 9999999999999.99 default: 0.0 valorCBS: type: string description: Valor do CBS na nota de fornecimento minimum: 0.00 maximum: 9999999999999.99 default: 0.0 qtdePerecimento: type: number format: double description: Quantidade roubada, perdida ou estragada e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida valorIBSCredito: type: string description: Valor do crédito do IBS (estorno) minimum: 0.00 maximum: 9999999999999.99 default: 0.0 valorCBSCredito: type: string description: Valor do crédito do CBS (estorno) minimum: 0.00 maximum: 9999999999999.99 default: 0.0 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeItemDetalhesPerecimentoEmitente: type: object required: – id allOf: – #/definitions/dfeItemDetalhesPerecimentoEmitente dfeItemDetalhesConsumoImp: description: Registro dos itens de Importação em ALC/ZFM não convertida em isenção para o evento 112120 type: object required: – dfeEventoDetalhes – numItem – qtde – e015med properties: id: type: string format: uuid description: Identificação única do registro dfeEventoDetalhes: type: object allOf: – #/definitions/dfeEventoDetalhe description: Detalhes do evento (relação 1:N, máximo 990 registros) numItem: type: integer format: int64 description: Número do item – Corresponde ao elemento det da NF-e de importação valorIBS: type: string description: Valor do IBS correspondente à quantidade que não atendeu aos requisitos para a conversão em isenção minimum: 0.00 maximum: 9999999999999.99 default: 0.0 valorCBS: type: string description: Valor do CBS correspondente à quantidade que não atendeu aos requisitos para a conversão em isenção minimum: 0.00 maximum: 9999999999999.99 default: 0.0 qtde: type: number format: double description: Quantidade que não atendeu os requisitos de conversão em isenção e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeItemDetalhesConsumoImp: type: object required: – id allOf: – #/definitions/dfeItemDetalhesConsumoImp dfeItemDetalhesPerecimentoDestinatario: description: Registrar os itens de Perecimento, perda, roubo ou furto durante o transporte contratado pelo adquirente para o evento 211124 type: object required: – dfeEventoDetalhes – numItem – qtdePerecimento – e015med – uPerecimento properties: id: type: string format: uuid description: Identificação única do registro dfeEventoDetalhes: type: object allOf: – #/definitions/dfeEventoDetalhe description: Detalhes do evento (relação 1:N, máximo 990 registros) numItem: type: integer format: int64 description: Número do item – Corresponde ao elemento det da nota de fornecimento valorIBS: type: string description: Valor do IBS na nota de fornecimento minimum: 0.00 maximum: 9999999999999.99 default: 0.0 valorCBS: type: string description: Valor do CBS na nota de fornecimento minimum: 0.00 maximum: 9999999999999.99 default: 0.0 qtdePerecimento: type: number format: double description: Quantidade roubada, perdida ou estragada e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida uPerecimento: type: string description: Unidade de medida relativa ao campo qPerecimento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editDfeItemDetalhesPerecimentoDestinatario: type: object required: – id allOf: – #/definitions/dfeItemDetalhesPerecimentoDestinatario e015med: description: Cadastros – Unidades de Medida type: object required: – uniMed – desMed properties: id: type: string format: uuid description: Id da entidade uniMed: type: string maxLength: 6 description: Unidade de medida desMed: type: string maxLength: 100 description: Descrição da unidade de medida excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070emp: description: Cadastros – Empresas type: object required: – codEmp – nomEmp – e031moe properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa e031moe: type: object allOf: – #/definitions/e031moe description: Moeda da empresa 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e031moe: description: Moeda type: object properties: id: type: string format: uuid description: Id da entidade codMoe: type: string maxLength: 3 description: Código moeda desMoe: type: string maxLength: 30 description: Descrição 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 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 required: – sigFil 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 sigFil: type: string maxLength: 100 description: Fantasia numCgc: type: string maxLength: 18 description: CPF/CNPJ numIdf: type: string maxLength: 40 description: Número identificação fiscal e008rai: type: object allOf: – #/definitions/e008rai description: Cidade excluido: type: boolean description: Indica se o registro foi excluído duplicando: type: boolean description: Indica se o registro está sendo duplicado 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e008rai: description: Cidade type: object required: – codRai – nomCid – e007ufs properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e007ufs: description: Estado type: object required: – sigUfs – nomUfs properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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