2.0info: 1.5.1 sefaz_gateway description: sefaz_gateway x-senior-domain: edocsx_common x-senior-domain-path: edocsx_common x-senior-service-path: sefaz_gateway contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/edocsx_commonsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /sefaz_gateway/queries/helloWorld: post: description: Primitiva de exemplo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – helloWorldMessage properties: helloWorldMessage: type: string description: Retorno da primitiva 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva de exemplo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – helloWorldMessage properties: helloWorldMessage: type: string description: Retorno da primitiva 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/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 /sefaz_gateway/queries/getUrlById: post: description: Retorna uma URL pelo ID tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificação unica do registro responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma URL pelo ID tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificação unica do registro in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/queries/getAllUrls: post: description: Obter todas as URLs cadastradas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – urls properties: urls: type: array items: type: object allOf: – #/definitions/urlShared minimum: 1 description: URLs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter todas as URLs cadastradas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – urls properties: urls: type: array items: type: object allOf: – #/definitions/urlShared minimum: 1 description: URLs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/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 /sefaz_gateway/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 /sefaz_gateway/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 /sefaz_gateway/queries/exportE070empReceitaIntegraCredentials: 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 /sefaz_gateway/queries/exportE070filReceitaIntegraCredentials: 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 /sefaz_gateway/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 /sefaz_gateway/actions/transmitSync: post: description: Transmissão síncrona de XML para webservice SEFAZ tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/transmitSyncInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/transmissionOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/actions/transmitRestSync: post: description: Execução síncrona de requisição REST autenticada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/transmitRestSyncInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/transmissionRestOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/actions/createUrl: post: description: Realiza o cadastro de uma nova URL tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createUrlRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/actions/updateUrl: post: description: Atualiza uma URL tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/updateUrlRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/urlShared 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/actions/deleteUrl: post: description: Deleta uma URL tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string maxLength: 255 description: Identificação unica do registro responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/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 /sefaz_gateway/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 /sefaz_gateway/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 /sefaz_gateway/actions/importE070empReceitaIntegraCredentials: 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 /sefaz_gateway/actions/importE070filReceitaIntegraCredentials: 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 /sefaz_gateway/signals/transmitAsync: post: description: Transmissão assíncrona de XML para webservice SEFAZ via fila tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/transmitAsyncInput responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sefaz_gateway/signals/transmitRestAsync: post: description: Execução assíncrona de requisição REST autenticada via fila tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/transmitRestAsyncInput responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /sefaz_gateway/events/transmitResponse: post: description: Evento publicado com o resultado da transmissão assíncrona x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – httpStatusCode – responseTimeMs properties: responseXml: type: string description: XML de resposta da SEFAZ httpStatusCode: type: integer format: int64 description: Código de status HTTP da resposta correlationId: type: string description: Identificador de correlação retornado errorType: type: string description: Tipo de erro ocorrido (COMMUNICATION_ERROR, CERTIFICATE_ERROR, VALIDATION_ERROR, INTERNAL_ERROR) errorMessage: type: string description: Mensagem descritiva do erro responseTimeMs: type: integer format: int64 description: Tempo de resposta em milissegundos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sefaz_gateway/events/transmitRestResponse: post: description: Evento publicado com o resultado da transmissão assíncrona REST x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/transmissionRestOutput responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sefaz_gateway/events/urlChanged: post: description: Evento publicado quando uma URL de webservice SEFAZ é criada, atualizada ou removida x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – documentType – environmentChanged properties: documentType: type: string allOf: – #/definitions/documentType description: Tipo do documento environmentChanged: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /sefaz_gateway/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 /sefaz_gateway/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 /sefaz_gateway/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 /sefaz_gateway/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 /sefaz_gateway/events/importE070empReceitaIntegraCredentialsEvent: 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 /sefaz_gateway/events/exportE070empReceitaIntegraCredentialsEvent: 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 /sefaz_gateway/events/importE070filReceitaIntegraCredentialsEvent: 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 /sefaz_gateway/events/exportE070filReceitaIntegraCredentialsEvent: 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 /sefaz_gateway/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 /sefaz_gateway/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/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 /sefaz_gateway/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/entities/e070empReceitaIntegraCredentials: 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/e070empReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/entities/e070empReceitaIntegraCredentials/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070empReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/entities/e070filReceitaIntegraCredentials: 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/e070filReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sefaz_gateway/entities/e070filReceitaIntegraCredentials/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070filReceitaIntegraCredentials 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: communicationType: type: string enum: – SOAP – REST description: Tipo de comunicação da URL (SOAP ou REST): * `SOAP` – Comunicação via SOAP * `REST` – Comunicação via REST authenticationType: type: string enum: – RECEITA_INTEGRA description: Tipo de autenticação para requisições REST: * `RECEITA_INTEGRA` – Autenticação via Receita Integra (OAuth2 client_credentials) responseType: type: string enum: – XML – URL description: Tipo de resposta REST: * `XML` – Resposta em XML * `URL` – Resposta como URL (blob service) restErrorType: type: string enum: – COMMUNICATION_ERROR – ACTIVE_CIRCUIT_BREAKER – VALIDATION_ERROR – INTERNAL_ERROR – AUTHENTICATION_ERROR – UNAUTHORIZED description: Tipos de erro possíveis em transmissão REST: * `COMMUNICATION_ERROR` – Erro de comunicação com a API * `ACTIVE_CIRCUIT_BREAKER` – Circuit breaker ativo * `VALIDATION_ERROR` – Erro de validação dos dados de entrada * `INTERNAL_ERROR` – Erro interno inesperado * `AUTHENTICATION_ERROR` – Credenciais de autenticação da empresa/filial ausentes ou mal configuradas * `UNAUTHORIZED` – Falha de autenticação persistente (401) após esgotar as tentativas de renovação de token upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down environmentType: type: string enum: – PROD – HOMOLOG – DISABLED – MOCK description: Tipo de aplicação do ambiente: * `PROD` – Produção * `HOMOLOG` – Homolog * `DISABLED` – Desativado * `MOCK` – Utilizado para mockar urls em ambiente de desenvolvimento documentType: type: string enum: – NFE – CTE – NFE_ABI – DERE – TAX_RECONCILIATION – NONE description: Tipo de documento: * `NFE` – NFe * `CTE` – CTe * `NFE_ABI` – NFeABI * `DERE` – Dere * `TAX_RECONCILIATION` – Conciliação de Impostos * `NONE` – Nenhum urlType: type: string enum: – DOCUMENT_ISSUE – DOCUMENT_ISSUE_STATUS – SEFAZ_STATUS – DOCUMENT_STATUS – EVENT_RECEPTION – NULLIFICATION – DFE_DISTRIBUTION – SERPRO_OAUTH2_TOKEN description: Tipo de URL: * `DOCUMENT_ISSUE` – Emissão de documento * `DOCUMENT_ISSUE_STATUS` – Consulta status da emissão de documento * `SEFAZ_STATUS` – Consulta da situação na Sefaz * `DOCUMENT_STATUS` – Consulta da situação do documento * `EVENT_RECEPTION` – Emissao de evento * `NULLIFICATION` – Emissão de inutilização * `DFE_DISTRIBUTION` – Distribuição de documento fiscal eletronicos * `SERPRO_OAUTH2_TOKEN` – Autenticação Serpro OAuth 2.0 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 urlParams: description: Parâmetros para resolução da URL do webservice type: object required: – documentType – operationType – ibgeStateCode – environmentType properties: documentType: type: string allOf: – #/definitions/documentType description: Tipo de documento fiscal (NFE, CTE, MDFE, NFSE) operationType: type: string allOf: – #/definitions/urlType description: Tipo de operação (DOCUMENT_ISSUE, DOCUMENT_STATUS, EVENT_RECEPTION, etc.) ibgeStateCode: type: string description: Código IBGE do estado (ex: 42 = SC, 35 = SP) environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente (PROD, HOMOLOG, MOCK) documentVersion: type: string description: Versão do layout do documento (ex: 4.00) pathParam: type: string description: Parâmetro de path a ser concatenado ao final da URL resolvida (ex: protocolo do lote para consulta). Opcional. transmitRestSyncInput: description: Entrada para execução síncrona de requisição REST type: object required: – branchId – bodyRequest – urlParams – responseType – attempt – authenticationType properties: branchId: type: string description: Identificador da filial (UUID) bodyRequest: type: string description: Corpo da requisição (XML, JSON ou texto) urlParams: type: object allOf: – #/definitions/urlParams description: Parâmetros para resolução da URL do serviço correlationId: type: string description: Identificador de correlação para rastreamento (UUID) responseType: type: string allOf: – #/definitions/responseType description: Tipo de resposta esperada (XML ou URL) attempt: type: integer format: int64 description: Número da tentativa authenticationType: type: string allOf: – #/definitions/authenticationType description: Tipo de autenticação para a requisição REST transmitRestAsyncInput: description: Entrada para execução assíncrona de requisição REST type: object required: – branchId – bodyRequest – attempt – urlParams – responseType – callbackDomain – callbackService – callbackPrimitive – authenticationType properties: branchId: type: string description: Identificador da filial (UUID) bodyRequest: type: string description: Corpo da requisição (XML, JSON ou texto) attempt: type: integer format: int64 description: Número da tentativa urlParams: type: object allOf: – #/definitions/urlParams description: Parâmetros para resolução da URL do serviço correlationId: type: string description: Identificador de correlação para rastreamento (UUID) responseType: type: string allOf: – #/definitions/responseType description: Tipo de resposta esperada (XML ou URL) callbackDomain: type: string description: Domínio do serviço de callback callbackService: type: string description: Serviço de callback callbackPrimitive: type: string description: Primitiva de callback authenticationType: type: string allOf: – #/definitions/authenticationType description: Tipo de autenticação para a requisição REST transmissionRestOutput: description: Saída padrão da transmissão REST type: object required: – httpStatusCode – responseTimeMs – responseType – attempt properties: response: type: string description: Resposta (pode ser XML ou URI dependendo do responseType) httpStatusCode: type: integer format: int64 description: Código de status HTTP da resposta correlationId: type: string description: Identificador de correlação retornado errorType: type: string allOf: – #/definitions/restErrorType description: Tipo de erro ocorrido errorMessage: type: string description: Mensagem descritiva do erro responseTimeMs: type: integer format: int64 description: Tempo de resposta em milissegundos responseType: type: string allOf: – #/definitions/responseType description: Tipo de resposta retornada attempt: type: integer format: int64 description: Número da tentativa transmitSyncInput: description: Entrada para transmissão síncrona type: object required: – xml – documentType – operationType – ibgeStateCode – environmentType – branchId – url – soapAction properties: xml: type: string description: XML bruto para transmissão documentType: type: string description: Tipo de documento fiscal (NFE, CTE, MDFE, NFSE) operationType: type: string description: Tipo de operação (DOCUMENT_ISSUE, DOCUMENT_STATUS, EVENT_RECEPTION, etc.) ibgeStateCode: type: string description: Código IBGE do estado (ex: 42 = SC, 35 = SP) environmentType: type: string description: Tipo de ambiente (PROD, HOMOLOG, MOCK) documentVersion: type: string description: Versão do layout do documento (ex: 4.00) branchId: type: string description: Identificador da filial (UUID) correlationId: type: string description: Identificador de correlação para rastreamento (UUID) url: type: string description: URL do webservice SEFAZ para transmissão soapAction: type: string description: SOAPAction do webservice SEFAZ transmitAsyncInput: description: Entrada para transmissão assíncrona type: object required: – xml – documentType – operationType – ibgeStateCode – environmentType – branchId – url – soapAction – callbackDomain – callbackService – callbackPrimitive properties: xml: type: string description: XML bruto para transmissão documentType: type: string description: Tipo de documento fiscal (NFE, CTE, MDFE, NFSE) operationType: type: string description: Tipo de operação (DOCUMENT_ISSUE, DOCUMENT_STATUS, EVENT_RECEPTION, etc.) ibgeStateCode: type: string description: Código IBGE do estado (ex: 42 = SC, 35 = SP) environmentType: type: string description: Tipo de ambiente (PROD, HOMOLOG, MOCK) documentVersion: type: string description: Versão do layout do documento (ex: 4.00) branchId: type: string description: Identificador da filial (UUID) correlationId: type: string description: Identificador de correlação para rastreamento (UUID) url: type: string description: URL do webservice SEFAZ para transmissão soapAction: type: string description: SOAPAction do webservice SEFAZ callbackDomain: type: string description: Domínio de callback callbackService: type: string description: Serviço de callback callbackPrimitive: type: string description: Primitiva de callback transmissionOutput: description: Saída padrão da transmissão type: object required: – httpStatusCode – responseTimeMs properties: responseXml: type: string description: XML de resposta da SEFAZ httpStatusCode: type: integer format: int64 description: Código de status HTTP da resposta correlationId: type: string description: Identificador de correlação retornado errorType: type: string description: Tipo de erro ocorrido (COMMUNICATION_ERROR, CERTIFICATE_ERROR, VALIDATION_ERROR, INTERNAL_ERROR) errorMessage: type: string description: Mensagem descritiva do erro responseTimeMs: type: integer format: int64 description: Tempo de resposta em milissegundos 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 createUrlRecord: description: Modelo requisitado para criação de uma nova URL type: object required: – url – documentType – urlType – documentVersion – ibgeStateCode – environmentType – communicationType properties: url: type: string maxLength: 255 description: URL documentType: type: string allOf: – #/definitions/documentType description: Tipo do documento urlType: type: string allOf: – #/definitions/urlType description: Tipo de URL documentVersion: type: string maxLength: 255 description: Versão do documento ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente soapAction: type: string maxLength: 255 description: SOAPAction do webservice communicationType: type: string allOf: – #/definitions/communicationType description: Tipo de comunicação (SOAP ou REST) restVerb: type: string maxLength: 255 description: Verbo HTTP para chamadas REST (GET, POST, etc.) updateUrlRecord: description: Modelo requisitado para atualização de uma URL type: object required: – id – url – documentType – urlType – documentVersion – ibgeStateCode – environmentType – communicationType properties: id: type: string maxLength: 255 description: identificação única do registro url: type: string maxLength: 255 description: URL documentType: type: string allOf: – #/definitions/documentType description: Tipo do documento urlType: type: string allOf: – #/definitions/urlType description: Tipo de URL documentVersion: type: string maxLength: 255 description: Versão do documento ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente soapAction: type: string maxLength: 255 description: SOAPAction do webservice communicationType: type: string allOf: – #/definitions/communicationType description: Tipo de comunicação (SOAP ou REST) restVerb: type: string maxLength: 255 description: Verbo HTTP para chamadas REST (GET, POST, etc.) urlShared: description: URL compartilhada type: object required: – id – url – documentType – urlType – documentVersion – ibgeStateCode – environmentType – communicationType properties: id: type: string maxLength: 255 description: identificação única do registro url: type: string maxLength: 255 description: URL documentType: type: string allOf: – #/definitions/documentType description: Tipo do documento urlType: type: string allOf: – #/definitions/urlType description: Tipo de URL documentVersion: type: string maxLength: 255 description: Versão do documento ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de aplicação do ambiente soapAction: type: string maxLength: 255 description: SOAPAction do webservice communicationType: type: string allOf: – #/definitions/communicationType description: Tipo de comunicação (SOAP ou REST) restVerb: type: string maxLength: 255 description: Verbo HTTP para chamadas REST (GET, POST, etc.) e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome numCgc: type: string maxLength: 18 description: CPF/CNPJ excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070empReceitaIntegraCredentials: description: Credenciais Receita Integra da empresa (leitura; mantidas pelo serviço foundation). O id e compartilhado com a e070emp. type: object properties: id: type: string format: uuid description: Id da entidade (igual ao id da empresa) clientId: type: string maxLength: 255 description: Client ID gerado pelo portal da Receita Federal clientSecret: type: string maxLength: 1024 description: Client Secret gerado pelo portal da Receita Federal (armazenado em Base64) usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filReceitaIntegraCredentials: description: Credenciais Receita Integra da filial (leitura; mantidas pelo serviço foundation). O id e compartilhado com a e070fil. type: object properties: id: type: string format: uuid description: Id da entidade (igual ao id da filial) clientId: type: string maxLength: 255 description: Client ID gerado pelo portal da Receita Federal clientSecret: type: string maxLength: 1024 description: Client Secret gerado pelo portal da Receita Federal (armazenado em Base64) 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