{"swagger":"2.0","info":{"description":"API para automação comercial e documentos fiscais.","version":"2.71.5","title":"API Nuvem Fiscal"},"host":"api.nuvemfiscal.com.br","basePath":"/","tags":[{"name":"Cep"},{"name":"Cnpj"},{"name":"Conta"},{"name":"Cte","description":"Conhecimento de Transporte Eletrônico."},{"name":"CteOs","description":"Conhecimento de Transporte Eletrônico - Outros serviços."},{"name":"Dce","description":"Declaração de Conteúdo Eletrônica."},{"name":"Debug","description":"Endpoints auxiliares voltados à análise técnica e depuração de documentos fiscais.\r\nPermitem rastrear o processamento de DF-es na API, incluindo o conteúdo\r\noriginal recebido e as requisições realizadas aos serviços autorizadores (SEFAZ, prefeituras, etc)."},{"name":"Distribuição NF-e","description":"O processo de distribuição de DFe envolve a disponibilização dos\r\ndocumentos fiscais eletrônicos para os envolvidos na transação (emitentes,\r\ndestinatários e terceiros autorizados). Ele permite que os destinatários\r\nrecebam as NF-e emitidas contra o seu CNPJ diretamente do Ambiente\r\nNacional, facilitando o controle e a gestão dos documentos recebidos."},{"name":"Email"},{"name":"Empresa","description":"Cadastre e administre todas as empresas vinculadas à sua conta."},{"name":"Mdfe","description":"Manifesto Eletrônico de Documentos Fiscais."},{"name":"Nfce","description":"Nota Fiscal de Consumidor Eletrônica."},{"name":"Nfcom","description":"Nota Fiscal Fatura de Serviço de Comunicação Eletrônica."},{"name":"Nfe","description":"Nota Fiscal Eletrônica."},{"name":"Nfse","description":"Nota Fiscal de Serviço Eletrônica."}],"schemes":["https"],"paths":{"/cep/{Cep}":{"get":{"tags":["Cep"],"summary":"Consultar endereço através do CEP","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#cep-consultas\">cep-consultas</a>\r\n- Consumo: 1 unidade requisição.","operationId":"ConsultarCep","produces":["application/json"],"parameters":[{"in":"path","name":"Cep","description":"CEP sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/CepEndereco"}}}}},"/cnpj":{"get":{"tags":["Cnpj"],"summary":"Listar estabelecimentos ativos a partir da base de CNPJ","description":"Retorna uma lista de estabelecimentos de acordo com os critérios de busca utilizados.\r\nSomente serão retornados estabelecimentos com situação cadastral \"Ativa\".\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#cnpj-listagem\">cnpj-listagem</a>\r\n- Consumo: 1 unidade por estabelecimento listado ou requisição.","operationId":"ListarCnpj","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cnae_principal","description":"Filtro pelo código CNAE da atividade principal do estabelecimento.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"municipio","description":"Filtro pelo código IBGE ou TOM (Tabela de Órgãos e Municípios) do município do estabelecimento.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"natureza_juridica","description":"Filtro pela natureza jurídica do estabelecimento\r\n Utilize o valor de quatro dígitos sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/CnpjListagem"}}}}},"/cnpj/{Cnpj}":{"get":{"tags":["Cnpj"],"summary":"Consultar dados do CNPJ","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#cnpj-consultas\">cnpj-consultas</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"ConsultarCnpj","produces":["application/json"],"parameters":[{"in":"path","name":"Cnpj","description":"CNPJ sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/CnpjEmpresa"}}}}},"/conta/cotas":{"get":{"tags":["Conta"],"summary":"Consultar os limites de uso e consumo de todas as cotas existentes.","operationId":"ListarCotasConta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/ContaCotaListagem"}}}}},"/conta/cotas/{nome}":{"get":{"tags":["Conta"],"summary":"Consultar o limite de uso e o consumo de uma cota específica.","operationId":"ConsultarCotaConta","produces":["application/json"],"parameters":[{"in":"path","name":"nome","description":"Nome da cota a ser consultada.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/ContaCota"}}}}},"/cte":{"get":{"tags":["Cte"],"summary":"Listar CT-e","description":"Retorna a lista de CT-e de acordo com os critérios de busca utilizados. Os CT-e são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarCte","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeListagem"}}}},"post":{"tags":["Cte"],"summary":"Emitir CT-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirCte","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CtePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/cte/eventos/{id}":{"get":{"tags":["Cte"],"summary":"Consultar evento","operationId":"ConsultarEventoCte","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeEvento"}}}}},"/cte/eventos/{id}/pdf":{"get":{"tags":["Cte"],"summary":"Baixar PDF do evento","operationId":"BaixarPdfEventoCte","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/eventos/{id}/xml":{"get":{"tags":["Cte"],"summary":"Baixar XML do evento","operationId":"BaixarXmlEventoCte","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/sefaz/status":{"get":{"tags":["Cte"],"summary":"Consulta do Status do Serviço na SEFAZ Autorizadora","description":"Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.\r\n\r\nA API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).","operationId":"ConsultarStatusSefazCte","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"autorizador","description":"Ambiente Autorizador.\r\n\r\nAutorizadores disponíveis: `MT`, `MS`, `MG`, `PR`, `RS`, `SP`, `SVRS`, `SVSP`, `AN`.\r\n\r\n*Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSefazStatus"}}}}},"/cte/simp":{"post":{"tags":["Cte"],"summary":"Emitir CT-e Simplificado","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirCteSimp","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CteSimpPedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/cte/{id}":{"get":{"tags":["Cte"],"summary":"Consultar CT-e","description":"Consulta os detalhes de um CT-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de CT-e e a API irá retornar as informações do CT-e correspondente.","operationId":"ConsultarCte","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/cte/{id}/cancelamento":{"get":{"tags":["Cte"],"summary":"Consultar o cancelamento do CT-e","operationId":"ConsultarCancelamentoCte","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}},"post":{"tags":["Cte"],"summary":"Cancelar um CT-e autorizado","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarCte","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/CtePedidoCancelamento"}},{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}}},"/cte/{id}/cancelamento/pdf":{"get":{"tags":["Cte"],"summary":"Baixar PDF do cancelamento","operationId":"BaixarPdfCancelamentoCte","parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/{id}/cancelamento/xml":{"get":{"tags":["Cte"],"summary":"Baixar XML do cancelamento","operationId":"BaixarXmlCancelamentoCte","parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/{id}/carta-correcao":{"get":{"tags":["Cte"],"summary":"Consultar a solicitação de correção do CT-e","operationId":"ConsultarCartaCorrecaoCte","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/CteCartaCorrecao"}}}},"post":{"tags":["Cte"],"summary":"Solicitar correção do CT-e","description":"É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CriarCartaCorrecaoCte","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CtePedidoCartaCorrecao"}},{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/CteCartaCorrecao"}}}}},"/cte/{id}/carta-correcao/pdf":{"get":{"tags":["Cte"],"summary":"Baixar PDF da carta de correção","operationId":"BaixarPdfCartaCorrecaoCte","parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/{id}/carta-correcao/xml":{"get":{"tags":["Cte"],"summary":"Baixar XML da carta de correção","operationId":"BaixarXmlCartaCorrecaoCte","parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/{id}/pdf":{"get":{"tags":["Cte"],"summary":"Baixar PDF do DACTE","operationId":"BaixarPdfCte","parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/{id}/sincronizar":{"post":{"tags":["Cte"],"summary":"Sincroniza dados no CT-e a partir da SEFAZ","description":"Realiza a sincronização dos dados a partir da consulta da situação atual da CT-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.\r\n\r\n**Cenários de uso**:\r\n* Sincronizar um CT-e que se encontra com o status `erro` na API, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).\r\n* Sincronizar um CT-e que se encontra com o status `autorizado`na API, mas está cancelado na SEFAZ.\r\n* Sincronizar todos os eventos de Cancelamento e Carta de Correção de um CT-e que porventura não tenham sido feitos a partir da API.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por evento sincronizado ou requisição.","operationId":"SincronizarCte","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSincronizacao"}}}}},"/cte/{id}/xml":{"get":{"tags":["Cte"],"summary":"Baixar XML do CT-e processado","description":"Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz `cteProc`).\r\n\r\nO XML só estará disponível nesse endpoint caso o conhecimento tenha sido autorizado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /cte/{id}/xml/conhecimento`.","operationId":"BaixarXmlCte","parameters":[{"in":"path","name":"id","description":"ID único do CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/{id}/xml/conhecimento":{"get":{"tags":["Cte"],"summary":"Baixar XML do CT-e","description":"Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ.\r\n\r\nO XML estará disponível nesse endpoint mesmo em casos que o conhecimento tenha sido rejeitado.","operationId":"BaixarXmlCteConhecimento","parameters":[{"in":"path","name":"id","description":"ID único da CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cte/{id}/xml/protocolo":{"get":{"tags":["Cte"],"summary":"Baixar XML do Protocolo da SEFAZ","operationId":"BaixarXmlCteProtocolo","parameters":[{"in":"path","name":"id","description":"ID único da CT-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos":{"get":{"tags":["CteOs"],"summary":"Listar CT-e OS","description":"Retorna a lista de CT-e OS de acordo com os critérios de busca utilizados. Os CT-e OS são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarCteOs","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeListagem"}}}},"post":{"tags":["CteOs"],"summary":"Emitir CT-e OS","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirCteOs","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CteOsPedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/cteos/eventos/{id}":{"get":{"tags":["CteOs"],"summary":"Consultar evento","operationId":"ConsultarEventoCteOs","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeEvento"}}}}},"/cteos/eventos/{id}/pdf":{"get":{"tags":["CteOs"],"summary":"Baixar PDF do evento","operationId":"BaixarPdfEventoCteOs","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/eventos/{id}/xml":{"get":{"tags":["CteOs"],"summary":"Baixar XML do evento","operationId":"BaixarXmlEventoCteOs","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/sefaz/status":{"get":{"tags":["CteOs"],"summary":"Consulta do Status do Serviço na SEFAZ Autorizadora","description":"Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.\r\n\r\nA API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).","operationId":"ConsultarStatusSefazCteOs","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"autorizador","description":"Ambiente Autorizador.\r\n\r\nAutorizadores disponíveis: `MT`, `MS`, `MG`, `PR`, `RS`, `SP`, `SVRS`, `SVSP`, `AN`.\r\n\r\n*Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSefazStatus"}}}}},"/cteos/{id}":{"get":{"tags":["CteOs"],"summary":"Consultar CT-e OS","description":"Consulta os detalhes de um CT-e OS já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de CT-e OS e a API irá retornar as informações do CT-e OS correspondente.","operationId":"ConsultarCteOs","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/cteos/{id}/cancelamento":{"get":{"tags":["CteOs"],"summary":"Consultar o cancelamento do CT-e OS","operationId":"ConsultarCancelamentoCteOs","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}},"post":{"tags":["CteOs"],"summary":"Cancelar um CT-e OS autorizado","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarCteOs","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/CteOsPedidoCancelamento"}},{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}}},"/cteos/{id}/cancelamento/pdf":{"get":{"tags":["CteOs"],"summary":"Baixar PDF do cancelamento","operationId":"BaixarPdfCancelamentoCteOs","parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/{id}/cancelamento/xml":{"get":{"tags":["CteOs"],"summary":"Baixar XML do cancelamento","operationId":"BaixarXmlCancelamentoCteOs","parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/{id}/carta-correcao":{"get":{"tags":["CteOs"],"summary":"Consultar a solicitação de correção do CT-e OS","operationId":"ConsultarCartaCorrecaoCteOs","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/CteOsCartaCorrecao"}}}},"post":{"tags":["CteOs"],"summary":"Solicitar correção do CT-e OS","description":"É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CriarCartaCorrecaoCteOs","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CteOsPedidoCartaCorrecao"}},{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/CteOsCartaCorrecao"}}}}},"/cteos/{id}/carta-correcao/pdf":{"get":{"tags":["CteOs"],"summary":"Baixar PDF da carta de correção","operationId":"BaixarPdfCartaCorrecaoCteOs","parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/{id}/carta-correcao/xml":{"get":{"tags":["CteOs"],"summary":"Baixar XML da carta de correção","operationId":"BaixarXmlCartaCorrecaoCteOs","parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/{id}/pdf":{"get":{"tags":["CteOs"],"summary":"Baixar PDF do DACTE","operationId":"BaixarPdfCteOs","parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/{id}/sincronizar":{"post":{"tags":["CteOs"],"summary":"Sincroniza dados no CT-e OS a partir da SEFAZ","description":"Realiza a sincronização dos dados a partir da consulta da situação atual do CT-e OS na Base de Dados do Portal da Secretaria de Fazenda Estadual.\r\n\r\n**Cenários de uso**:\r\n* Sincronizar um CT-e OS que se encontra com o status `erro` na API, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).\r\n* Sincronizar um CT-e OS que se encontra com o status `autorizado`na API, mas está cancelado na SEFAZ.\r\n* Sincronizar todos os eventos de Cancelamento e Carta de Correção de um CT-e OS que porventura não tenham sido feitos a partir da API.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por evento sincronizado ou requisição.","operationId":"SincronizarCteOs","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSincronizacao"}}}}},"/cteos/{id}/xml":{"get":{"tags":["CteOs"],"summary":"Baixar XML do CT-e OS processado","description":"Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz `cteProc`).\r\n\r\nO XML só estará disponível nesse endpoint caso o conhecimento tenha sido autorizado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /cteos/{id}/xml/conhecimento`.","operationId":"BaixarXmlCteOs","parameters":[{"in":"path","name":"id","description":"ID único do CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/{id}/xml/conhecimento":{"get":{"tags":["CteOs"],"summary":"Baixar XML do CT-e OS","description":"Utilize esse endpoint para obter o XML do conhecimento enviado para a SEFAZ.\r\n\r\nO XML estará disponível nesse endpoint mesmo em casos que o conhecimento tenha sido rejeitado.","operationId":"BaixarXmlCteOsConhecimento","parameters":[{"in":"path","name":"id","description":"ID único da CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/cteos/{id}/xml/protocolo":{"get":{"tags":["CteOs"],"summary":"Baixar XML do Protocolo da SEFAZ","operationId":"BaixarXmlCteOsProtocolo","parameters":[{"in":"path","name":"id","description":"ID único da CT-e OS gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/dce":{"get":{"tags":["Dce"],"summary":"Listar DC-e","description":"Retorna a lista de DC-e de acordo com os critérios de busca utilizados. As DC-e são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarDce","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeListagem"}}}},"post":{"tags":["Dce"],"summary":"Emitir DC-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirDce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DcePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/dce/sefaz/status":{"get":{"tags":["Dce"],"summary":"Consulta do Status do Serviço na SEFAZ Autorizadora","description":"Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.\r\n\r\nA API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ.","operationId":"ConsultarStatusSefazDce","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"autorizador","description":"Ambiente Autorizador.\r\n\r\nAutorizadores disponíveis: `AN`.\r\n\r\n*Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSefazStatus"}}}}},"/dce/{id}":{"get":{"tags":["Dce"],"summary":"Consultar DC-e","description":"Consulta os detalhes de uma DC-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de DC-e e a API irá retornar as informações da DC-e correspondente.","operationId":"ConsultarDce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da DC-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/dce/{id}/cancelamento":{"get":{"tags":["Dce"],"summary":"Consultar o cancelamento da DC-e","operationId":"ConsultarCancelamentoDce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da DC-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}},"post":{"tags":["Dce"],"summary":"Cancelar uma DC-e autorizada","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarDce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/DcePedidoCancelamento"}},{"in":"path","name":"id","description":"ID único da DC-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}}},"/dce/{id}/cancelamento/xml":{"get":{"tags":["Dce"],"summary":"Baixar XML do cancelamento","operationId":"BaixarXmlCancelamentoDce","parameters":[{"in":"path","name":"id","description":"ID único da DC-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/dce/{id}/pdf":{"get":{"tags":["Dce"],"summary":"Baixar PDF do DACE","operationId":"BaixarPdfDce","parameters":[{"in":"path","name":"id","description":"ID único da DC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/dce/{id}/xml":{"get":{"tags":["Dce"],"summary":"Baixar XML da DC-e processada","description":"Utilize esse endpoint para obter o XML da DC-e enviada para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz `dceProc`).\r\n\r\nO XML só estará disponível nesse endpoint caso a DC-e tenha sido autorizada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /dce/{id}/xml/declaracao`.","operationId":"BaixarXmlDce","parameters":[{"in":"path","name":"id","description":"ID único da DC-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/dce/{id}/xml/declaracao":{"get":{"tags":["Dce"],"summary":"Baixar XML da DC-e","description":"Utilize esse endpoint para obter o XML da DC-e enviada para a SEFAZ.\r\n\r\nO XML estará disponível nesse endpoint mesmo em casos que a declaração tenha sido rejeitada.","operationId":"BaixarXmlDceDeclaracao","parameters":[{"in":"path","name":"id","description":"ID único da DC-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/dce/{id}/xml/protocolo":{"get":{"tags":["Dce"],"summary":"Baixar XML do Protocolo da SEFAZ","operationId":"BaixarXmlDceProtocolo","parameters":[{"in":"path","name":"id","description":"ID único da DC-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/debug/http-requests/{id}/request-content":{"get":{"tags":["Debug"],"summary":"Corpo da requisição HTTP","description":"Este endpoint retorna apenas o corpo da requisição HTTP enviada ao autorizador,\r\npreservando o conteúdo exatamente como foi armazenado pela API.\r\n\r\n**Informações retornadas**:\r\n- Envelope SOAP da requisição, possivelmente compactado.\r\n\r\n**Cenários de uso**:\r\n- Verificação do XML ou SOAP efetivamente enviado.\r\n- Encaminhamento ao suporte da SEFAZ ou prefeitura para análise.\r\n- Diagnóstico técnico do conteúdo de envio.","operationId":"DebugHttpRequestContent","parameters":[{"in":"path","name":"id","description":"ID da requisição HTTP.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/debug/http-requests/{id}/response-content":{"get":{"tags":["Debug"],"summary":"Corpo da resposta HTTP","description":"Este endpoint retorna apenas o corpo da resposta HTTP recebida do autorizador,\r\npermitindo análise técnica da mensagem retornada pela SEFAZ ou prefeitura.\r\n\r\n**Informações retornadas**:\r\n- Envelope SOAP da resposta, ou mensagem de erro (ex: HTML, XML), no formato original.\r\n\r\n**Cenários de uso**:\r\n- Inspeção da resposta real retornada pelo autorizador.\r\n- Encaminhamento do conteúdo ao suporte técnico.\r\n- Diagnóstico de rejeições, falhas de processamento ou erros de infraestrutura.","operationId":"DebugHttpResponseContent","parameters":[{"in":"path","name":"id","description":"ID da requisição HTTP.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/debug/{id}":{"get":{"tags":["Debug"],"summary":"Debug de DF-e","description":"Este endpoint retorna informações detalhadas de debug sobre o processamento de um documento fiscal eletrônico (DFe),\r\ncomo NF-e, NFC-e, MDF-e, CT-e, NFS-e, dentre outros. Ele permite inspecionar o conteúdo original enviado à API e analisar\r\ntodas as interações realizadas com os serviços autorizadores (SEFAZ ou prefeituras) durante o fluxo de emissão.\r\n\r\n**Informações retornadas**:\r\n- JSON original recebido no momento da criação do documento.\r\n- Histórico das etapas de envio e consulta.\r\n- Status e mensagens retornadas pelo autorizador.\r\n\r\n**Cenários de uso**:\r\n- Diagnóstico de falhas no processamento do documento.\r\n- Verificação da resposta da SEFAZ ou prefeitura.\r\n- Apoio ao suporte técnico e análise de integração.","operationId":"DebugDfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do documento fiscal gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeDebug"}}}}},"/debug/{id}/original-payload":{"get":{"tags":["Debug"],"summary":"Payload original recebido","description":"Este endpoint retorna o conteúdo original recebido pela API no momento da criação do documento fiscal.\r\n\r\n**Cenários de uso**:\r\n- Inspeção detalhada dos dados enviados à API.\r\n- Verificação de divergências entre o payload fornecido e o processado.\r\n- Encaminhamento do conteúdo original ao suporte da API.","operationId":"DebugDfeOriginalPayload","parameters":[{"in":"path","name":"id","description":"ID do documento fiscal gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/distribuicao/nfe":{"get":{"tags":["Distribuição NF-e"],"summary":"Listar distribuições","description":"Retorna a lista de distribuições de NF-e de acordo com os critérios de busca utilizados. As distribuições são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarDistribuicaoNfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfeListagem"}}}},"post":{"tags":["Distribuição NF-e"],"summary":"Distribuir documentos","description":"Este endpoint permite que o destinatário obtenha Documentos Fiscais\r\nEletrônicos (DF-e) emitidos contra o seu CNPJ ou CPF ou que seja de\r\nseu interesse. A distribuição pode ser feita de três formas:\r\n*dist-nsu*, *cons-nsu* e *cons-chave*.\r\n\r\n**Formas de Consulta**:\r\n- *dist-nsu*: Consulta pelo último NSU recebido.\r\n- *cons-nsu*: Consulta por um NSU específico.\r\n- *cons-chave*: Consulta pela chave de acesso da NF-e.\r\n\r\n**Retorno da Solicitação**\r\n\r\nA resposta da solicitação inclui a propriedade *status* no JSON, que\r\npode ter os seguintes valores:\r\n- *processando*: A solicitação está em andamento.\r\n- *concluido*: A solicitação foi processada com sucesso.\r\n- *erro*: Ocorreu um erro no processamento da solicitação.\r\n\r\nSe o status retornado for *processando*, significa que a solicitação está\r\nsendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá\r\nadotar um fluxo que consiste em requisitar periodicamente o endpoint\r\n<a href=\"#tag/Distribuicao-NF-e/operation/ConsultarDistribuicaoNfe\">consultar distribuição</a> até que\r\na API retorne o pedido com um status indicando o fim do\r\nprocessamento (concluido ou erro).\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por documento distribuído (retornado) ou requisição.","operationId":"GerarDistribuicaoNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DistribuicaoNfePedido"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfe"}}}}},"/distribuicao/nfe/documentos":{"get":{"tags":["Distribuição NF-e"],"summary":"Listar documentos","description":"Retorna a lista de documentos fiscais eletrônicos de interesse da pessoa ou empresa de acordo com os critérios de busca utilizados. Os documentos são retornadas ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarDocumentoDistribuicaoNfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"dist_nsu","description":"Filtrar por documentos a partir do NSU informado.","type":"integer","format":"int64"},{"in":"query","name":"tipo_documento","description":"Filtrar pelo tipo do documento de interesse da pessoa ou empresa.\r\n\r\nValores aceitos: `nota`, `evento`","type":"string"},{"in":"query","name":"forma_distribuicao","description":"Filtrar por documentos que foram distribuídos em sua forma resumida ou completa.\r\n\r\nValores aceitos: `resumida`, `completa`","type":"string"},{"in":"query","name":"chave_acesso","description":"Filtrar pela chave de acesso da NF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfeDocumentoListagem"}}}}},"/distribuicao/nfe/documentos/{id}":{"get":{"tags":["Distribuição NF-e"],"summary":"Consultar documento","description":"Utilize esse endpoint para obter as informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.","operationId":"ConsultarDocumentoDistribuicaoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do documento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfeDocumento"}}}}},"/distribuicao/nfe/documentos/{id}/pdf":{"get":{"tags":["Distribuição NF-e"],"summary":"Baixar PDF do documento","description":"Utilize esse endpoint para obter o PDF do documento.\r\n\r\nSchemas suportados:\r\n* procNFe_v4.00.xsd","operationId":"BaixarPdfDocumentoDistribuicaoNfe","parameters":[{"in":"path","name":"id","description":"ID único do documento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/distribuicao/nfe/documentos/{id}/xml":{"get":{"tags":["Distribuição NF-e"],"summary":"Baixar XML do documento","description":"Utilize esse endpoint para obter o XML das informações resumidas ou documento fiscal de interesse da pessoa ou empresa interessada.","operationId":"BaixarXmlDocumentoDistribuicaoNfe","parameters":[{"in":"path","name":"id","description":"ID único do documento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/distribuicao/nfe/manifestacoes":{"get":{"tags":["Distribuição NF-e"],"summary":"Listar Manifestações","description":"Retorna a lista de manifestações de NF-e de acordo com os critérios de busca utilizados. As manifestações são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarManifestacaoNfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do autor do evento.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/ManifestacaoNfeListagem"}}}},"post":{"tags":["Distribuição NF-e"],"summary":"Manifestar nota","description":"O processo de manifestação do destinatário permite que os destinatários\r\nde Notas Fiscais Eletrônicas (NF-e) registrem formalmente sua posição em\r\nrelação às operações descritas nesses documentos fiscais. Ele envolve\r\neventos que indicam se a operação foi confirmada, desconhecida ou\r\nnão realizada.\r\n\r\nOs seguintes tipos de manifestação são suportados pela NF-e:\r\n* **Confirmação da Operação (210200)**: Manifestação do destinatário confirmando que a operação descrita na NF-e ocorreu exatamente como informado na NF-e. Esse evento libera a possibilidade de download da NF-e pelo destinatário e impede que a empresa emitente cancele a NF-e após a confirmação.\r\n* **Ciência da Operação (210210)**: Declara que o destinatário tem ciência da existência da NF-e, mas ainda não possui elementos suficientes para manifestar-se conclusivamente. Este é um evento opcional que pode ser usado pelo destinatário para indicar que está ciente da NF-e enquanto coleta mais informações. Esse evento libera a possibilidade de download da NF-e pelo destinatário.\r\n* **Desconhecimento da Operação (210220)**: Manifestação do destinatário declarando que a operação descrita da NF-e não foi por ele solicitada.\r\n* **Operação não Realizada (210240)**: Manifestação do destinatário reconhecendo sua participação na operação descrita na NF-e, mas declarando que a operação não ocorreu ou não se efetivou como informado nesta NF-e.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"ManifestarNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contém os dados do pedido para manifestação do destinatário.","required":true,"schema":{"$ref":"#/definitions/DistribuicaoNfePedidoManifestacao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfeEvento"}}}}},"/distribuicao/nfe/manifestacoes/{id}":{"get":{"tags":["Distribuição NF-e"],"summary":"Consultar manifestação","description":"Consulta os detalhes de uma manifestação de NF-e já existente. Forneça o ID único obtido de uma requisição de manifestação ou de listagem de manifestações e a API irá retornar as informações da manifestação correspondente.","operationId":"ConsultarManifestacaoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da manifestação gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfeEvento"}}}}},"/distribuicao/nfe/notas-sem-manifestacao":{"get":{"tags":["Distribuição NF-e"],"summary":"Listar notas sem manifestação","description":"No processo de distribuição de DF-e, as notas fiscais eletrônicas (NF-e)\r\nsão inicialmente disponibilizadas de forma resumida. Para obter o XML\r\ncompleto, o destinatário deve manifestar a ciência da operação e,\r\nposteriormente, uma manifestação conclusiva dentro de um prazo legal.\r\n\r\nPara facilitar essa gestão e o cumprimento dos prazos legais de manifestação,\r\na API permite listar as notas que ainda não\r\npossuem manifestação, ajudando os usuários a identificar rapidamente as\r\nnotas que necessitam de ação.\r\n\r\nO usuário pode optar por listar apenas as notas que não possuem manifestação\r\nconclusiva ou que não possuem qualquer tipo de manifestação. Essa flexibilidade\r\npermite um controle mais preciso e adequado às necessidades operacionais\r\nde cada empresa.\r\n\r\nOs documentos são retornados ordenados decrescentemente pela data de\r\ndistribuição, permitindo uma visualização clara e organizada das notas\r\nmais recentes.\r\n\r\n**Cenários de uso:**\r\n* Identificar rapidamente as notas que ainda precisam de manifestação para obter o XML completo.\r\n* Listar todas as notas fiscais eletrônicas que foram registradas com ciência da operação, mas ainda não possuem uma manifestação conclusiva (confirmação da operação, desconhecimento da operação ou operação não realizada).\r\n* Listar todas as notas fiscais eletrônicas que não possuem nenhum tipo de manifestação registrada (nem ciência da operação, nem manifestação conclusiva).","operationId":"ListarNfeSemManifestacao","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ da pessoa ou empresa interessada.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"conclusiva","description":"Indica se serão consideradas apenas as manifestações conclusivas.\r\n\r\nValores:\r\n* `false`: serão retornadas notas que não possuírem qualquer tipo de\r\n  manifestação.\r\n\r\n* `true`: apenas as notas que não possuírem manifestação conclusiva\r\n  serão retornadas. Ou seja, notas que tenham sido manifestadas apenas\r\n  com Ciência da Operação (210210) continuarão sendo retornadas por\r\n  esse endpoint até que recebam uma manifestação conclusiva.","type":"boolean","default":false}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfeNotaListagem"}}}}},"/distribuicao/nfe/{id}":{"get":{"tags":["Distribuição NF-e"],"summary":"Consultar distribuição","operationId":"ConsultarDistribuicaoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da distribuição de NF-e gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DistribuicaoNfe"}}}}},"/emails":{"get":{"tags":["Email"],"summary":"Listar e-mails","description":"Retorna a lista dos emails associadas à sua conta. Os e-emails são\r\nretornados ordenados pela data da criação, com os mais recentes\r\naparecendo primeiro.","operationId":"ListarEmails","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtra pelo CPF ou CNPJ da empresa.\r\n\r\n*Utilize o valor sem máscara*.","required":true,"type":"string"},{"in":"query","name":"undelivered","description":"Filtra apenas emails com problemas de entrega.","type":"boolean"},{"in":"query","name":"email","description":"Filtra pelo endereço de e-mail do destinatário para qual o email foi enviado.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmailListagem"}}}}},"/emails/{id}":{"get":{"tags":["Email"],"summary":"Consultar e-mail","description":"Obtém informações detalhadas sobre o envio de um email. Este endpoint\r\npermite rastrear todos os eventos relacionados ao email, como envio,\r\nentrega, falhas e outros eventos relevantes.\r\n\r\nCom este endpoint, é possível ter uma visão completa do ciclo de vida\r\nde um email enviado, permitindo que os usuários acompanhem e analisem\r\no status e o histórico de eventos do email. Isso é particularmente\r\nútil para identificar problemas de entrega e entender o comportamento\r\ndo email ao longo do tempo.","operationId":"ConsultarEmail","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do e-mail.\r\n\r\nEsse parâmetro é obtido após o envio do email por qualquer endpoint da\r\nAPI que realize disparos de email.\r\n\r\nExemplos:\r\n* <a href=\"#tag/Nfe/operation/EnviarEmailNfe\">Envio de XML e PDF de NF-e</a>.\r\n* <a href=\"#tag/Nfce/operation/EnviarEmailNfce\">Envio de XML e PDF de NFC-e</a>.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Email"}}}}},"/empresas":{"get":{"tags":["Empresa"],"summary":"Listar empresas","description":"Retorna a lista das empresas associadas à sua conta. As empresas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarEmpresas","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ da empresa.\r\n\r\n*Utilize o valor sem máscara*.","type":"string"},{"in":"query","name":"nome_razao_social","description":"Filtrar pelo nome ou razão social da empresa.\r\n\r\nEsse filtro realiza uma correspondência pelo início do texto,\r\nretornando apenas empresas cujo nome ou razão social começam com\r\no valor informado.\r\n\r\n*Caso o filtro pelo CPF ou CNPJ também seja informado na requisição,\r\neste filtro é ignorado*.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaListagem"}}}},"post":{"tags":["Empresa"],"summary":"Cadastrar empresa","description":"Cadastre uma nova empresa (emitente ou prestador) à sua conta.","operationId":"CriarEmpresa","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Empresa"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Empresa"}}}}},"/empresas/certificados":{"get":{"tags":["Empresa"],"summary":"Listar certificados","description":"Retorna a lista dos certificados associadas à sua conta. Os certificados são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarCertificados","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"expires_in","description":"Filtrar certificados que expiram dentro de X dias.\r\n\r\nInforme um número inteiro correspondente à quantidade de dias até o vencimento.\r\nExemplos:\r\n - expires_in=30 -&gt; certificados que vencem nos próximos 30 dias.\r\n - expires_in=7  -&gt; certificados que vencem nos próximos 7 dias.","type":"integer","minimum":0,"exclusiveMinimum":true},{"in":"query","name":"include_expired","description":"Indicar se os certificados já vencidos devem ser incluídos no resultado.\r\n\r\nValores aceitos:\r\n - `true`: incluir certificados vencidos.\r\n - `false`: exibir apenas certificados válidos.","type":"boolean","default":true}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaCertificadoListagem"}}}}},"/empresas/{cpf_cnpj}":{"get":{"tags":["Empresa"],"summary":"Consultar empresa","operationId":"ConsultarEmpresa","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Empresa"}}}},"put":{"tags":["Empresa"],"summary":"Alterar empresa","description":"Altera o cadastro de uma empresa (emitente/prestador) que esteja associada a sua conta.\r\nNesse método, por tratar-se de um PUT, caso algum campo não seja informado, o valor dele será apagado.","operationId":"AtualizarEmpresa","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Empresa"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Empresa"}}}},"delete":{"tags":["Empresa"],"summary":"Deletar empresa","operationId":"ExcluirEmpresa","parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"204":{"description":"Successful response"}}}},"/empresas/{cpf_cnpj}/certificado":{"get":{"tags":["Empresa"],"summary":"Consultar certificado","operationId":"ConsultarCertificadoEmpresa","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaCertificado"}}}},"put":{"tags":["Empresa"],"summary":"Cadastrar certificado","description":"Cadastre ou atualize um certificado digital e vincule a sua empresa, para que possa iniciar a emissão de notas.\r\n* No parâmetro `certificado`, envie o binário do certificado digital (.pfx ou .p12) codificado em **base64**.","operationId":"CadastrarCertificadoEmpresa","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaPedidoCadastroCertificado"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaCertificado"}}}},"delete":{"tags":["Empresa"],"summary":"Deletar certificado","operationId":"ExcluirCertificadoEmpresa","parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"204":{"description":"Successful response"}}}},"/empresas/{cpf_cnpj}/certificado/upload":{"put":{"tags":["Empresa"],"summary":"Upload de certificado","description":"Cadastre ou atualize um certificado digital e vincule a sua empresa, para que possa iniciar a emissão de notas.\r\n* Utilize o `content-type` igual a `multipart/form-data`.\r\n* No parâmetro `file`, envie o binário do arquivo (.pfx ou .p12) do certificado digital.\r\n* No parâmetro `password`, envie a senha do certificado.","operationId":"EnviarCertificadoEmpresa","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"in":"formData","name":"Input","type":"file"},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaCertificado"}}}}},"/empresas/{cpf_cnpj}/cte":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de CT-e","operationId":"ConsultarConfigCte","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigCte"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de CT-e","operationId":"AlterarConfigCte","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigCte"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigCte"}}}}},"/empresas/{cpf_cnpj}/cteos":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de CT-e OS","operationId":"ConsultarConfigCteOs","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigCteOs"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de CT-e OS","operationId":"AlterarConfigCteOs","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigCteOs"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigCteOs"}}}}},"/empresas/{cpf_cnpj}/dce":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de DC-e","operationId":"ConsultarConfigDce","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigDce"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de DC-e","operationId":"AlterarConfigDce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigDce"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigDce"}}}}},"/empresas/{cpf_cnpj}/distnfe":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de Distribuição de NF-e","operationId":"ConsultarConfigDistribuicaoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigDistribuicaoNfe"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de Distribuição de NF-e","operationId":"AlterarConfigDistribuicaoNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigDistribuicaoNfe"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigDistribuicaoNfe"}}}}},"/empresas/{cpf_cnpj}/logotipo":{"get":{"tags":["Empresa"],"summary":"Baixar logotipo","operationId":"BaixarLogotipoEmpresa","parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}},"put":{"tags":["Empresa"],"summary":"Enviar logotipo","description":"Cadastre ou atualize um logotipo e vincule a sua empresa.\r\n\r\n**Restrições:**\r\n* Tipos de mídia (MIME) suportados: `image/png` e `image/jpeg`\r\n* Tamanho máximo do arquivo: 200 KB\r\n\r\n**Cenários de uso:**\r\n* Quero que minhas notas sejam impressas com esse logotipo.\r\n* Quero trocar o logotipo utilizado em minhas impressões.","operationId":"EnviarLogotipoEmpresa","consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"Input","type":"file"},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"204":{"description":"Successful response"}}},"delete":{"tags":["Empresa"],"summary":"Deletar logotipo","operationId":"ExcluirLogotipoEmpresa","parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"204":{"description":"Successful response"}}}},"/empresas/{cpf_cnpj}/mdfe":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de MDF-e","operationId":"ConsultarConfigMdfe","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigMdfe"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de MDF-e","operationId":"AlterarConfigMdfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigMdfe"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigMdfe"}}}}},"/empresas/{cpf_cnpj}/nfce":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de NFC-e","operationId":"ConsultarConfigNfce","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfce"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de NFC-e","operationId":"AlterarConfigNfce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigNfce"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfce"}}}}},"/empresas/{cpf_cnpj}/nfcom":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de NFCom","operationId":"ConsultarConfigNfcom","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfcom"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de NFCom","operationId":"AlterarConfigNfcom","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigNfcom"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfcom"}}}}},"/empresas/{cpf_cnpj}/nfe":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de NF-e","operationId":"ConsultarConfigNfe","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfe"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de NF-e","operationId":"AlterarConfigNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigNfe"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfe"}}}}},"/empresas/{cpf_cnpj}/nfse":{"get":{"tags":["Empresa"],"summary":"Consultar configuração de NFS-e","operationId":"ConsultarConfigNfse","produces":["application/json"],"parameters":[{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfse"}}}},"put":{"tags":["Empresa"],"summary":"Alterar configuração de NFS-e","operationId":"AlterarConfigNfse","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmpresaConfigNfse"}},{"in":"path","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmpresaConfigNfse"}}}}},"/mdfe":{"get":{"tags":["Mdfe"],"summary":"Listar MDF-e","description":"Retorna a lista de manifestos de acordo com os critérios de busca utilizados. Os manifestos são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarMdfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeListagem"}}}},"post":{"tags":["Mdfe"],"summary":"Emitir MDF-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirMdfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MdfePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/mdfe/eventos/{id}":{"get":{"tags":["Mdfe"],"summary":"Consultar evento do MDF-e","operationId":"ConsultarEventoMdfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeEvento"}}}}},"/mdfe/eventos/{id}/pdf":{"get":{"tags":["Mdfe"],"summary":"Baixar PDF do evento","operationId":"BaixarPdfEventoMdfe","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/eventos/{id}/xml":{"get":{"tags":["Mdfe"],"summary":"Baixar XML do evento","operationId":"BaixarXmlEventoMdfe","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/lotes":{"get":{"tags":["Mdfe"],"summary":"Listar lotes de MDF-e","description":"Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarLotesMdfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLoteListagem"}}}},"post":{"tags":["Mdfe"],"summary":"Emitir lote de MDF-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por MDF-e.","operationId":"EmitirLoteMdfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MdfePedidoEmissaoLote"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLote"}}}}},"/mdfe/lotes/{id}":{"get":{"tags":["Mdfe"],"summary":"Consultar lote de MDF-e","description":"Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.","operationId":"ConsultarLoteMdfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do lote gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLote"}}}}},"/mdfe/nao-encerrados":{"get":{"tags":["Mdfe"],"summary":"Consulta MDF-e não encerrados","operationId":"ConsultarMdfeNaoEncerrados","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/MdfeNaoEncerrados"}}}}},"/mdfe/sefaz/status":{"get":{"tags":["Mdfe"],"summary":"Consulta do Status do Serviço na SEFAZ Autorizadora","description":"Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.\r\n\r\nA API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).","operationId":"ConsultarStatusSefazMdfe","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"autorizador","description":"Ambiente Autorizador.\r\n\r\nAutorizadores disponíveis: `SVRS`.\r\n\r\n*Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSefazStatus"}}}}},"/mdfe/{id}":{"get":{"tags":["Mdfe"],"summary":"Consultar manifesto","description":"Consulta os detalhes de um manifesto já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de manifestos e a API irá retornar as informações do manifesto correspondente.","operationId":"ConsultarMdfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/mdfe/{id}/cancelamento":{"get":{"tags":["Mdfe"],"summary":"Consultar o cancelamento do MDF-e","operationId":"ConsultarCancelamentoMdfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}},"post":{"tags":["Mdfe"],"summary":"Cancelar um MDF-e autorizado","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarMdfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Dados do cancelamento.","schema":{"$ref":"#/definitions/MdfePedidoCancelamento"}},{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}}},"/mdfe/{id}/cancelamento/pdf":{"get":{"tags":["Mdfe"],"summary":"Baixar PDF do cancelamento","operationId":"BaixarPdfCancelamentoMdfe","parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/{id}/cancelamento/xml":{"get":{"tags":["Mdfe"],"summary":"Baixar XML do cancelamento","operationId":"BaixarXmlCancelamentoMdfe","parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/{id}/encerramento":{"get":{"tags":["Mdfe"],"summary":"Consultar encerramento do MDF-e","operationId":"ConsultarEncerramentoMdfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/MdfeEncerramento"}}}},"post":{"tags":["Mdfe"],"summary":"Encerrar um MDF-e autorizado","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EncerrarMdfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MdfePedidoEncerramento"}},{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/MdfeEncerramento"}}}}},"/mdfe/{id}/encerramento/pdf":{"get":{"tags":["Mdfe"],"summary":"Baixar PDF do encerramento","operationId":"BaixarPdfEncerramentoMdfe","parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/{id}/encerramento/xml":{"get":{"tags":["Mdfe"],"summary":"Baixar XML do encerramento","operationId":"BaixarXmlEncerramentoMdfe","parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/{id}/inclusao-condutor":{"post":{"tags":["Mdfe"],"summary":"Incluir um condutor em um MDF-e autorizado","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"IncluirCondutorMdfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MdfePedidoInclusaoCondutor"}},{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/MdfeInclusaoCondutor"}}}}},"/mdfe/{id}/inclusao-dfe":{"post":{"tags":["Mdfe"],"summary":"Incluir um DF-e em um MDF-e autorizado","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"IncluirDfeMdfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/MdfePedidoInclusaoDfe"}},{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/MdfeInclusaoDfe"}}}}},"/mdfe/{id}/pdf":{"get":{"tags":["Mdfe"],"summary":"Baixar PDF do DAMDFE","operationId":"BaixarPdfMdfe","parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/{id}/sincronizar":{"post":{"tags":["Mdfe"],"summary":"Sincroniza dados no MDF-e a partir da SEFAZ","description":"Realiza a sincronização dos dados a partir da consulta da situação atual da MDF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.\r\n\r\n**Cenários de uso**:\r\n* Sincronizar um manifesto que se encontra com o status `erro` na API, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).\r\n* Sincronizar um manifesto que se encontra com o status `autorizado`na API, mas está cancelado ou encerrado na SEFAZ.\r\n* Sincronizar todos os eventos de Cancelamento, Encerramento, Inclusão de condutor e Inclusão de DF-e de um manifesto que porventura não tenham sido feitos a partir da API.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por evento sincronizado ou requisição.","operationId":"SincronizarMdfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSincronizacao"}}}}},"/mdfe/{id}/xml":{"get":{"tags":["Mdfe"],"summary":"Baixar XML do MDF-e processado","description":"Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz `mdfeProc`).\r\n\r\nO XML só estará disponível nesse endpoint caso o manifesto tenha sido autorizado ou denegado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /mdfe/{id}/xml/manifesto`.","operationId":"BaixarXmlMdfe","parameters":[{"in":"path","name":"id","description":"ID único do MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/{id}/xml/manifesto":{"get":{"tags":["Mdfe"],"summary":"Baixar XML do MDF-e","description":"Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ.\r\n\r\nO XML estará disponível nesse endpoint mesmo em casos que o manifesto tenha sido rejeitado.","operationId":"BaixarXmlMdfeManifesto","parameters":[{"in":"path","name":"id","description":"ID único da MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/mdfe/{id}/xml/protocolo":{"get":{"tags":["Mdfe"],"summary":"Baixar XML do Protocolo da SEFAZ","operationId":"BaixarXmlMdfeProtocolo","parameters":[{"in":"path","name":"id","description":"ID único da MDF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce":{"get":{"tags":["Nfce"],"summary":"Listar NFC-e","description":"Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarNfce","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeListagem"}}}},"post":{"tags":["Nfce"],"summary":"Emitir NFC-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirNfce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/nfce/eventos":{"get":{"tags":["Nfce"],"summary":"Listar eventos","description":"Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarEventosNfce","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"dfe_id","description":"ID único gerado pela API para o documento fiscal.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeEventoListagem"}}}}},"/nfce/eventos/{id}":{"get":{"tags":["Nfce"],"summary":"Consultar evento","operationId":"ConsultarEventoNfce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeEvento"}}}}},"/nfce/eventos/{id}/pdf":{"get":{"tags":["Nfce"],"summary":"Baixar PDF do evento","operationId":"BaixarPdfEventoNfce","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/eventos/{id}/xml":{"get":{"tags":["Nfce"],"summary":"Baixar XML do evento","operationId":"BaixarXmlEventoNfce","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/inutilizacoes":{"post":{"tags":["Nfce"],"summary":"Inutilizar uma sequência de numeração de NFC-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"InutilizarNumeracaoNfce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DfePedidoInutilizacao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeInutilizacao"}}}}},"/nfce/inutilizacoes/{id}":{"get":{"tags":["Nfce"],"summary":"Consultar a inutilização de sequência de numeração","operationId":"ConsultarInutilizacaoNfce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeInutilizacao"}}}}},"/nfce/inutilizacoes/{id}/pdf":{"get":{"tags":["Nfce"],"summary":"Baixar PDF da inutilização","operationId":"BaixarPdfInutilizacaoNfce","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/inutilizacoes/{id}/xml":{"get":{"tags":["Nfce"],"summary":"Baixar XML da inutilização","operationId":"BaixarXmlInutilizacaoNfce","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/lotes":{"get":{"tags":["Nfce"],"summary":"Listar lotes de NFC-e","description":"Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarLotesNfce","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLoteListagem"}}}},"post":{"tags":["Nfce"],"summary":"Emitir lote de NFC-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por NFC-e.","operationId":"EmitirLoteNfce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissaoLote"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLote"}}}}},"/nfce/lotes/{id}":{"get":{"tags":["Nfce"],"summary":"Consultar lote de NFC-e","description":"Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.","operationId":"ConsultarLoteNfce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do lote gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLote"}}}}},"/nfce/previa/pdf":{"post":{"tags":["Nfce"],"summary":"Prévia do PDF do DANFCE","description":"Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do DANFCE.\r\n\r\nOs dados de entrada são os mesmos do endpoint de emissão de NFC-e (`POST /nfce`).\r\n\r\n**Atenção**: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"BaixarPreviaPdfNfce","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissao"}},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false},{"in":"query","name":"nome_fantasia","description":"Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.","type":"boolean","default":false},{"in":"query","name":"mensagem_rodape","description":"Imprime mensagem no rodapé do documento.\r\n\r\nO caractere `|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.\r\n\r\n**Exemplos de Uso:**\r\n* `\"esquerda\"`\r\n* `\"esquerda|centro\"`\r\n* `\"esquerda|centro|direita\"`\r\n* `\"|centro\"`, `\"|centro|\"`\r\n* `\"|centro|direita\"`\r\n* `\"||direita\"`\r\n* `\"esquerda||direita\"`","type":"string","default":"","maxLength":120},{"in":"query","name":"resumido","description":"Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.","type":"boolean","default":false},{"in":"query","name":"qrcode_lateral","description":"Imprime o QRCode na lateral do DANFE NFC-e.\r\n\r\n*Disponível apenas para DANFE com 80 milímetros de largura*.","type":"boolean","default":false},{"in":"query","name":"largura","description":"Largura do DANFE NFC-e (em milímetros).","type":"integer","default":80,"maximum":80,"minimum":40},{"in":"query","name":"margem","description":"Define as margens do DANFE NFC-e (em milímetros).\r\n\r\nEssa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre `0` e `9`.\r\n* Quando **um** valor é especificado, a mesma margem é aplicada para **todos os quatro lados**.\r\n* Quando **dois** valores são especificados, a primeira margem é aplicada aos **lados esquerdo e direito**, e a segunda aos **lados superior e inferior**.\r\n* Quando **três** valores são especificados, a primeira margem é aplicada ao **lado esquerdo**, a segunda aos **lados superior e inferior**, e a terceira ao **lado direito**.\r\n* Quando **quatro** valores são especificados, as margens são aplicadas aos lados **esquerdo**, **superior**, **direito** e **inferior**, nesta ordem (sentido horário).\r\n\r\n**Exemplos de uso**:\r\n* `margem=1`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 1mm\r\n  - Margem direita: 1mm\r\n  - Margem inferior: 1mm\r\n* `margem=1,2`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 2mm\r\n  - Margem direita: 1mm\r\n  - Margem inferior: 2mm\r\n* `margem=1,2,3`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 2mm\r\n  - Margem direita: 3mm\r\n  - Margem inferior: 2mm\r\n* `margem=1,2,3,4`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 2mm\r\n  - Margem direita: 3mm\r\n  - Margem inferior: 4mm","type":"string","default":"2"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/previa/xml":{"post":{"tags":["Nfce"],"summary":"Prévia do XML da NFC-e","description":"Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do XML, sem a assinatura digital.\r\n\r\nOs dados de entrada são os mesmos do endpoint de emissão de NFC-e (`POST /nfce`).\r\n\r\n**Atenção**: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"BaixarPreviaXmlNfce","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/sefaz/status":{"get":{"tags":["Nfce"],"summary":"Consulta do Status do Serviço na SEFAZ Autorizadora","description":"Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.\r\n\r\nA API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 7.0, item 5.5.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).","operationId":"ConsultarStatusSefazNfce","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"autorizador","description":"Ambiente Autorizador.\r\n\r\nAutorizadores disponíveis: `AM`, `BA`, `CE`, `GO`, `MG`, `MS`, `MT`, `PE`, `PR`, `RS`, `SP`, `SVRS`.\r\n\r\n*Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSefazStatus"}}}}},"/nfce/{id}":{"get":{"tags":["Nfce"],"summary":"Consultar NFC-e","description":"Consulta os detalhes de uma NFC-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de notas e a API irá retornar as informações da nota correspondente.","operationId":"ConsultarNfce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/nfce/{id}/cancelamento":{"get":{"tags":["Nfce"],"summary":"Consultar o cancelamento da NFC-e","operationId":"ConsultarCancelamentoNfce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}},"post":{"tags":["Nfce"],"summary":"Cancelar uma NFC-e autorizada","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarNfce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/NfePedidoCancelamento"}},{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}}},"/nfce/{id}/cancelamento/pdf":{"get":{"tags":["Nfce"],"summary":"Baixar PDF do cancelamento","operationId":"BaixarPdfCancelamentoNfce","parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/{id}/cancelamento/xml":{"get":{"tags":["Nfce"],"summary":"Baixar XML do cancelamento","operationId":"BaixarXmlCancelamentoNfce","parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/{id}/email":{"post":{"tags":["Nfce"],"summary":"Enviar e-mail","description":"Envia o XML e PDF da nota via email.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EnviarEmailNfce","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/DfePedidoEnvioEmail"}},{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmailStatusResponse"}}}}},"/nfce/{id}/escpos":{"get":{"tags":["Nfce"],"summary":"Comandos ESC/POS para impressão do DANFCE","description":"ESC/POS é um sistema de comando criado pela Epson usado em diversos sistemas de impressoras POS.\r\n\r\nCom o formato ESC/POS, você poderá imprimir nativamente em uma vasta quantidade de modelos de impressora térmicas utilizadas no Brasil e no mundo. Com ela, você consegue fazer o envio de comandos em ESC/POS direto para a porta da impressora.","operationId":"BaixarEscPosNfce","parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"},{"in":"query","name":"modelo","description":"Modelo da impressora:\r\n* `0` - Texto\r\n* `1` - Epson\r\n* `2` - Bematech\r\n* `3` - Daruma\r\n* `4` - Vox\r\n* `5` - Diebold\r\n* `6` - Epson P2\r\n* `7` - CustomPos\r\n* `8` - Star\r\n* `9` - Zjiang\r\n* `10` - GPrinter\r\n* `11` - Datecs\r\n* `12` - Sunmi\r\n* `13` - Externo","type":"integer","default":1,"maximum":13,"minimum":0},{"in":"query","name":"colunas","description":"Define o máximo de caracteres, em uma linha, usando a fonte normal.\r\n\r\nEx: 40, 42, 48, 58, 80.","type":"integer","default":48},{"in":"query","name":"qrcode_lateral","description":"Imprime o QRCode na lateral do DANFCe.\r\n\r\nOBS: não suportado por alguns modelos de impressora.","type":"boolean","default":false}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/{id}/pdf":{"get":{"tags":["Nfce"],"summary":"Baixar PDF do DANFCE","operationId":"BaixarPdfNfce","parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false},{"in":"query","name":"nome_fantasia","description":"Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.","type":"boolean","default":false},{"in":"query","name":"mensagem_rodape","description":"Imprime mensagem no rodapé do documento.\r\n\r\nO caractere `|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.\r\n\r\n**Exemplos de Uso:**\r\n* `\"esquerda\"`\r\n* `\"esquerda|centro\"`\r\n* `\"esquerda|centro|direita\"`\r\n* `\"|centro\"`, `\"|centro|\"`\r\n* `\"|centro|direita\"`\r\n* `\"||direita\"`\r\n* `\"esquerda||direita\"`","type":"string","default":"","maxLength":120},{"in":"query","name":"resumido","description":"Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.","type":"boolean","default":false},{"in":"query","name":"qrcode_lateral","description":"Imprime o QRCode na lateral do DANFE NFC-e.\r\n\r\n*Disponível apenas para DANFE com 80 milímetros de largura*.","type":"boolean","default":false},{"in":"query","name":"largura","description":"Largura do DANFE NFC-e (em milímetros).","type":"integer","default":80,"maximum":80,"minimum":40},{"in":"query","name":"margem","description":"Define as margens do DANFE NFC-e (em milímetros).\r\n\r\nEssa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre `0` e `9`.\r\n* Quando **um** valor é especificado, a mesma margem é aplicada para **todos os quatro lados**.\r\n* Quando **dois** valores são especificados, a primeira margem é aplicada aos **lados esquerdo e direito**, e a segunda aos **lados superior e inferior**.\r\n* Quando **três** valores são especificados, a primeira margem é aplicada ao **lado esquerdo**, a segunda aos **lados superior e inferior**, e a terceira ao **lado direito**.\r\n* Quando **quatro** valores são especificados, as margens são aplicadas aos lados **esquerdo**, **superior**, **direito** e **inferior**, nesta ordem (sentido horário).\r\n\r\n**Exemplos de uso**:\r\n* `margem=1`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 1mm\r\n  - Margem direita: 1mm\r\n  - Margem inferior: 1mm\r\n* `margem=1,2`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 2mm\r\n  - Margem direita: 1mm\r\n  - Margem inferior: 2mm\r\n* `margem=1,2,3`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 2mm\r\n  - Margem direita: 3mm\r\n  - Margem inferior: 2mm\r\n* `margem=1,2,3,4`\r\n  - Margem esquerda: 1mm\r\n  - Margem superior: 2mm\r\n  - Margem direita: 3mm\r\n  - Margem inferior: 4mm","type":"string","default":"2"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/{id}/sincronizar":{"post":{"tags":["Nfce"],"summary":"Sincroniza dados na NFC-e a partir da SEFAZ","description":"Realiza a sincronização dos dados a partir da consulta da situação atual da NFC-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.\r\n\r\n**Cenários de uso**:\r\n* Sincronizar uma nota que se encontra com o status `erro` na API, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).\r\n* Sincronizar uma nota que se encontra com o status `autorizado`na API, mas está cancelada na SEFAZ.\r\n* Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota que porventura não tenham sido feitos a partir da API.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por evento sincronizado ou requisição.","operationId":"SincronizarNfce","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSincronizacao"}}}}},"/nfce/{id}/xml":{"get":{"tags":["Nfce"],"summary":"Baixar XML da NFC-e processada","description":"Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz `nfeProc`).\r\n\r\nO XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /nfce/{id}/xml/nota`.","operationId":"BaixarXmlNfce","parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/{id}/xml/nota":{"get":{"tags":["Nfce"],"summary":"Baixar XML da NFC-e","description":"Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ.\r\n\r\nO XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.","operationId":"BaixarXmlNfceNota","parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfce/{id}/xml/protocolo":{"get":{"tags":["Nfce"],"summary":"Baixar XML do Protocolo da SEFAZ","operationId":"BaixarXmlNfceProtocolo","parameters":[{"in":"path","name":"id","description":"ID único da NFC-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfcom":{"get":{"tags":["Nfcom"],"summary":"Listar NFCom","description":"Retorna a lista de NFCom de acordo com os critérios de busca utilizados. As NFCom são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarNfcom","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeListagem"}}}},"post":{"tags":["Nfcom"],"summary":"Emitir NFCom","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirNfcom","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfcomPedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/nfcom/sefaz/status":{"get":{"tags":["Nfcom"],"summary":"Consulta do Status do Serviço na SEFAZ Autorizadora","description":"Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.\r\n\r\nA API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ.","operationId":"ConsultarStatusSefazNfcom","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"autorizador","description":"Ambiente Autorizador.\r\n\r\nAutorizadores disponíveis: `SVRS`.\r\n\r\n*Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSefazStatus"}}}}},"/nfcom/{id}":{"get":{"tags":["Nfcom"],"summary":"Consultar NFCom","description":"Consulta os detalhes de uma NFCom já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de NFCom e a API irá retornar as informações da NFCom correspondente.","operationId":"ConsultarNfcom","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NFCom gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/nfcom/{id}/cancelamento":{"get":{"tags":["Nfcom"],"summary":"Consultar o cancelamento da NFCom","operationId":"ConsultarCancelamentoNfcom","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NFCom gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}},"post":{"tags":["Nfcom"],"summary":"Cancelar uma NFCom autorizada","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarNfcom","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/NfcomPedidoCancelamento"}},{"in":"path","name":"id","description":"ID único da NFCom gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}}},"/nfcom/{id}/cancelamento/xml":{"get":{"tags":["Nfcom"],"summary":"Baixar XML do cancelamento","operationId":"BaixarXmlCancelamentoNfcom","parameters":[{"in":"path","name":"id","description":"ID único da NFCom gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfcom/{id}/pdf":{"get":{"tags":["Nfcom"],"summary":"Baixar PDF do DANFE-COM","operationId":"BaixarPdfNfcom","parameters":[{"in":"path","name":"id","description":"ID único da NFCom gerado pela API.","required":true,"type":"string"},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfcom/{id}/xml":{"get":{"tags":["Nfcom"],"summary":"Baixar XML da NFCom processada","description":"Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz `nfcomProc`).\r\n\r\nO XML só estará disponível nesse endpoint caso a nota tenha sido autorizada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /nfcom/{id}/xml/nota`.","operationId":"BaixarXmlNfcom","parameters":[{"in":"path","name":"id","description":"ID único da NFCom gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfcom/{id}/xml/nota":{"get":{"tags":["Nfcom"],"summary":"Baixar XML da NFCom","description":"Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ.\r\n\r\nO XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.","operationId":"BaixarXmlNfcomNota","parameters":[{"in":"path","name":"id","description":"ID único da NFCom gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfcom/{id}/xml/protocolo":{"get":{"tags":["Nfcom"],"summary":"Baixar XML do Protocolo da SEFAZ","operationId":"BaixarXmlNfcomProtocolo","parameters":[{"in":"path","name":"id","description":"ID único da NFCom gerada pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe":{"get":{"tags":["Nfe"],"summary":"Listar NF-e","description":"Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarNfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeListagem"}}}},"post":{"tags":["Nfe"],"summary":"Emitir NF-e","description":"Este endpoint permite a emissão de Notas Fiscais Eletrônicas (NF-e).\r\nA solicitação deve ser feita enviando os dados necessários para a\r\nemissão de uma NF-e. \r\n\r\nA estrutura do JSON utilizado na solicitação segue a hierarquia e\r\nnomenclatura de campos definidos no <a href=\"https://www.nfe.fazenda.gov.br/portal/principal.aspx\" target=\"_blank\">\r\nManual de Orientação ao Contribuinte (MOC)</a>.\r\nEsta conformidade visa facilitar a integração de novos usuários que já\r\npossuem familiaridade com o padrão, além de permitir a resolução de\r\ndúvidas diretamente no MOC, com um profissional de contabilidade\r\nhabilitado ou em outras fontes confiáveis que tratam do mesmo assunto.\r\n\r\n**Comportamento Assíncrono**\r\n\r\nA resposta desse endpoint inclui a propriedade *status* no JSON.\r\nCaso o valor retornado seja *pendente*, significa que a solicitação está\r\nsendo realizada de forma assíncrona pela API. Nesse caso, o usuário deverá\r\nadotar um fluxo que consiste em requisitar periodicamente o endpoint\r\n<a href=\"#tag/Nfe/operation/ConsultarNfe\">Consultar NF-e</a> até que\r\nseja retornado um status indicando o fim da emissão.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/nfe/cadastro-contribuinte":{"get":{"tags":["Nfe"],"summary":"Consultar contribuinte","description":"Consulta o Cadastro Centralizado de Contribuintes (CCC) do ICMS da unidade federada.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"ConsultarContribuinteNfe","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF ou CNPJ da empresa.\r\n\r\n*Utilize o valor sem máscara*.","required":true,"type":"string"},{"in":"query","name":"uf","description":"Sigla da UF consultada.\r\n\r\n Utilize `SU` para SUFRAMA.\r\n\r\n*Caso não seja informada, será utilizada a UF da empresa.*","type":"string"},{"in":"query","name":"argumento","description":"Argumento de pesquisa.\r\n\r\nValores válidos:\r\n* `CNPJ`\r\n* `CPF`\r\n* `IE`","required":true,"type":"string"},{"in":"query","name":"documento","description":"Documento a ser consultado (CNPJ, CPF ou Inscrição Estadual).","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeContribuinteInfCons"}}}}},"/nfe/eventos":{"get":{"tags":["Nfe"],"summary":"Listar eventos","description":"Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarEventosNfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"dfe_id","description":"ID único gerado pela API para o documento fiscal.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeEventoListagem"}}}}},"/nfe/eventos/{id}":{"get":{"tags":["Nfe"],"summary":"Consultar evento","operationId":"ConsultarEventoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeEvento"}}}}},"/nfe/eventos/{id}/pdf":{"get":{"tags":["Nfe"],"summary":"Baixar PDF do evento","operationId":"BaixarPdfEventoNfe","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/eventos/{id}/xml":{"get":{"tags":["Nfe"],"summary":"Baixar XML do evento","operationId":"BaixarXmlEventoNfe","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/inutilizacoes":{"post":{"tags":["Nfe"],"summary":"Inutilizar uma sequência de numeração de NF-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"InutilizarNumeracaoNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/DfePedidoInutilizacao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeInutilizacao"}}}}},"/nfe/inutilizacoes/{id}":{"get":{"tags":["Nfe"],"summary":"Consultar a inutilização de sequência de numeração","operationId":"ConsultarInutilizacaoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeInutilizacao"}}}}},"/nfe/inutilizacoes/{id}/pdf":{"get":{"tags":["Nfe"],"summary":"Baixar PDF da inutilização","operationId":"BaixarPdfInutilizacaoNfe","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/inutilizacoes/{id}/xml":{"get":{"tags":["Nfe"],"summary":"Baixar XML da inutilização","operationId":"BaixarXmlInutilizacaoNfe","parameters":[{"in":"path","name":"id","description":"ID único do evento gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/lotes":{"get":{"tags":["Nfe"],"summary":"Listar lotes de NF-e","description":"Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarLotesNfe","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLoteListagem"}}}},"post":{"tags":["Nfe"],"summary":"Emitir lote de NF-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por NF-e.","operationId":"EmitirLoteNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissaoLote"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLote"}}}}},"/nfe/lotes/{id}":{"get":{"tags":["Nfe"],"summary":"Consultar lote de NF-e","description":"Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.","operationId":"ConsultarLoteNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do lote gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeLote"}}}}},"/nfe/previa/pdf":{"post":{"tags":["Nfe"],"summary":"Prévia do PDF do DANFE","description":"Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do DANFE.\r\n\r\nOs dados de entrada são os mesmos do endpoint de emissão de NF-e (`POST /nfe`).\r\n\r\n**Atenção**: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"BaixarPreviaPdfNfe","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissao"}},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false},{"in":"query","name":"nome_fantasia","description":"Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.","type":"boolean","default":false},{"in":"query","name":"formato","description":"Formato de impressão do DANFE.\r\n\r\nValores disponíveis:\r\n- `padrao`: será utilizado o formato definido no XML da NF-e (tag \"tpImp\");\r\n- `retrato`: tamanho A4 em modo retrato;\r\n- `paisagem`: tamanho A4 em modo paisagem;\r\n- `simplificado`: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11);\r\n- `etiqueta`: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004).","type":"string","default":"padrao"},{"in":"query","name":"mensagem_rodape","description":"Imprime mensagem no rodapé do documento.\r\n\r\nO caractere `|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.\r\n\r\n**Exemplos de Uso:**\r\n* `\"esquerda\"`\r\n* `\"esquerda|centro\"`\r\n* `\"esquerda|centro|direita\"`\r\n* `\"|centro\"`, `\"|centro|\"`\r\n* `\"|centro|direita\"`\r\n* `\"||direita\"`\r\n* `\"esquerda||direita\"`","type":"string","default":"","maxLength":120},{"in":"query","name":"canhoto","description":"Imprime o documento com o bloco de canhoto.","type":"boolean","default":true}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/previa/xml":{"post":{"tags":["Nfe"],"summary":"Prévia do XML da NF-e","description":"Através desse endpoint, é possível enviar os dados de uma NF-e e gerar uma prévia do XML, sem a assinatura digital.\r\n\r\nOs dados de entrada são os mesmos do endpoint de emissão de NF-e (`POST /nfe`).\r\n\r\n**Atenção**: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"BaixarPreviaXmlNfe","consumes":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/sefaz/status":{"get":{"tags":["Nfe"],"summary":"Consulta do Status do Serviço na SEFAZ Autorizadora","description":"Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.\r\n\r\nA API mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 7.0, item 5.5.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).","operationId":"ConsultarStatusSefazNfe","produces":["application/json"],"parameters":[{"in":"query","name":"cpf_cnpj","description":"CPF/CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"autorizador","description":"Ambiente Autorizador.\r\n\r\nAutorizadores disponíveis: `AM`, `BA`, `GO`, `MG`, `MS`, `MT`, `PE`, `PR`, `RS`, `SP`, `SVAN`, `SVRS`, `SVCAN`, `SVCRS`, `AN`.\r\n\r\n*Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSefazStatus"}}}}},"/nfe/{id}":{"get":{"tags":["Nfe"],"summary":"Consultar NF-e","description":"Consulta os detalhes de uma NF-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de notas e a API irá retornar as informações da nota correspondente.","operationId":"ConsultarNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Dfe"}}}}},"/nfe/{id}/cancelamento":{"get":{"tags":["Nfe"],"summary":"Consultar o cancelamento da NF-e","operationId":"ConsultarCancelamentoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}},"post":{"tags":["Nfe"],"summary":"Cancelar uma NF-e autorizada","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/NfePedidoCancelamento"}},{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCancelamento"}}}}},"/nfe/{id}/cancelamento/pdf":{"get":{"tags":["Nfe"],"summary":"Baixar PDF do cancelamento","operationId":"BaixarPdfCancelamentoNfe","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/{id}/cancelamento/xml":{"get":{"tags":["Nfe"],"summary":"Baixar XML do cancelamento","operationId":"BaixarXmlCancelamentoNfe","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/{id}/carta-correcao":{"get":{"tags":["Nfe"],"summary":"Consultar a solicitação de correção da NF-e","operationId":"ConsultarCartaCorrecaoNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCartaCorrecao"}}}},"post":{"tags":["Nfe"],"summary":"Solicitar correção da NF-e","description":"É possível enviar até 20 correções diferentes, sendo que será válido sempre a última correção enviada.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CriarCartaCorrecaoNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contém os dados do pedido para carta de correção.","required":true,"schema":{"$ref":"#/definitions/NfePedidoCartaCorrecao"}},{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeCartaCorrecao"}}}}},"/nfe/{id}/carta-correcao/pdf":{"get":{"tags":["Nfe"],"summary":"Baixar PDF da carta de correção","operationId":"BaixarPdfCartaCorrecaoNfe","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/{id}/carta-correcao/xml":{"get":{"tags":["Nfe"],"summary":"Baixar XML da carta de correção","operationId":"BaixarXmlCartaCorrecaoNfe","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/{id}/email":{"post":{"tags":["Nfe"],"summary":"Enviar e-mail","description":"Envia o XML e PDF da nota via email.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EnviarEmailNfe","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/DfePedidoEnvioEmail"}},{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/EmailStatusResponse"}}}}},"/nfe/{id}/pdf":{"get":{"tags":["Nfe"],"summary":"Baixar PDF do DANFE","operationId":"BaixarPdfNfe","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false},{"in":"query","name":"nome_fantasia","description":"Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.","type":"boolean","default":false},{"in":"query","name":"formato","description":"Formato de impressão do DANFE.\r\n\r\nValores disponíveis:\r\n- `padrao`: será utilizado o formato definido no XML da NF-e (tag \"tpImp\");\r\n- `retrato`: tamanho A4 em modo retrato;\r\n- `paisagem`: tamanho A4 em modo paisagem;\r\n- `simplificado`: formato simplificado utilizado nas operações realizadas fora do estabelecimento (Anexo II do MOC, item 3.11);\r\n- `etiqueta`: formato simplificado utilizado nas operações em comércio eletrônico (Anexo II do MOC, item 3.12 e NT 2020.004).","type":"string","default":"padrao"},{"in":"query","name":"mensagem_rodape","description":"Imprime mensagem no rodapé do documento.\r\n\r\nO caractere `|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.\r\n\r\n**Exemplos de Uso:**\r\n* `\"esquerda\"`\r\n* `\"esquerda|centro\"`\r\n* `\"esquerda|centro|direita\"`\r\n* `\"|centro\"`, `\"|centro|\"`\r\n* `\"|centro|direita\"`\r\n* `\"||direita\"`\r\n* `\"esquerda||direita\"`","type":"string","default":"","maxLength":120},{"in":"query","name":"canhoto","description":"Imprime o documento com o bloco de canhoto.","type":"boolean","default":true}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/{id}/sincronizar":{"post":{"tags":["Nfe"],"summary":"Sincroniza dados na NF-e a partir da SEFAZ","description":"Realiza a sincronização dos dados a partir da consulta da situação atual da NF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.\r\n\r\n**Cenários de uso**:\r\n* Sincronizar uma nota que se encontra com o status `erro` na API, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).\r\n* Sincronizar uma nota que se encontra com o status `autorizado`na API, mas está cancelada na SEFAZ.\r\n* Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota que porventura não tenham sido feitos a partir da API.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por evento sincronizado ou requisição.","operationId":"SincronizarNfe","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/DfeSincronizacao"}}}}},"/nfe/{id}/xml":{"get":{"tags":["Nfe"],"summary":"Baixar XML da NF-e processada","description":"Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz `nfeProc`).\r\n\r\nO XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /nfe/{id}/xml/nota`.","operationId":"BaixarXmlNfe","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/{id}/xml/nota":{"get":{"tags":["Nfe"],"summary":"Baixar XML da NF-e","description":"Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ.\r\n\r\nO XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.","operationId":"BaixarXmlNfeNota","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfe/{id}/xml/protocolo":{"get":{"tags":["Nfe"],"summary":"Baixar XML do Protocolo da SEFAZ","operationId":"BaixarXmlNfeProtocolo","parameters":[{"in":"path","name":"id","description":"ID único da NF-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfse":{"get":{"tags":["Nfse"],"summary":"Listar NFS-e","description":"Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as mais recentes aparecendo primeiro.","operationId":"ListarNfse","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\n\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","description":"Seu identificador único para o documento.","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"},{"in":"query","name":"chave","description":"Chave de acesso do DF-e.","type":"string"},{"in":"query","name":"serie","description":"Série do DF-e.","type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/NfseListagem"}}}},"post":{"tags":["Nfse"],"summary":"Emitir NFS-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirNfse","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfsePedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Nfse"}}},"deprecated":true}},"/nfse/cidades":{"get":{"tags":["Nfse"],"summary":"Cidades atendidas","description":"Fornece uma relação completa de todos os municípios atendidos pela API.","operationId":"CidadesAtendidas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/NfseCidadesAtendidas"}}}}},"/nfse/cidades/{codigo_ibge}":{"get":{"tags":["Nfse"],"summary":"Consultar metadados","description":"Consulta a disponibilidade de emissão e alguns metadados de um município.","operationId":"ConsultarMetadados","produces":["application/json"],"parameters":[{"in":"path","name":"codigo_ibge","description":"Código IBGE do município.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/NfseCidadeMetadados"}}}}},"/nfse/dps":{"post":{"tags":["Nfse"],"summary":"Emitir NFS-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"EmitirNfseDps","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfseDpsPedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Nfse"}}}}},"/nfse/dps/lotes":{"post":{"tags":["Nfse"],"summary":"Emitir lote de NFS-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por NFS-e.","operationId":"EmitirLoteNfseDps","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/NfseLoteDpsPedidoEmissao"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/RpsLote"}}}}},"/nfse/lotes":{"get":{"tags":["Nfse"],"summary":"Listar lotes de NFS-e","description":"Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.","operationId":"ListarLotesNfse","produces":["application/json"],"parameters":[{"in":"query","name":"$top","description":"Limite no número de objetos a serem retornados pela API, entre 1 e 100.","type":"integer","default":10},{"in":"query","name":"$skip","description":"Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.","type":"integer","default":0},{"in":"query","name":"$inlinecount","description":"Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.","type":"boolean","default":false},{"in":"query","name":"cpf_cnpj","description":"Filtrar pelo CPF ou CNPJ do emitente.\r\nUtilize o valor sem máscara.","required":true,"type":"string"},{"in":"query","name":"referencia","type":"string"},{"in":"query","name":"ambiente","description":"Identificação do Ambiente.\r\n\r\nValores aceitos: homologacao, producao","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/RpsLoteListagem"}}}},"post":{"tags":["Nfse"],"summary":"Emitir lote de NFS-e","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por NFS-e.","operationId":"EmitirLoteNfse","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/RpsPedidoEmissaoLote"}}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/RpsLote"}}},"deprecated":true}},"/nfse/lotes/{id}":{"get":{"tags":["Nfse"],"summary":"Consultar lote de NFS-e","description":"Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a API irá retornar as informações do lote correspondente.","operationId":"ConsultarLoteNfse","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único do lote gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/RpsLote"}}}}},"/nfse/{Id}/cancelamento/xml":{"get":{"tags":["Nfse"],"summary":"Baixar XML do evento de cancelamento","operationId":"BaixarXmlCancelamentoNfse","parameters":[{"in":"path","name":"Id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfse/{id}":{"get":{"tags":["Nfse"],"summary":"Consultar NFS-e","description":"Consulta os detalhes de uma NFS-e já existente. Forneça o ID único obtido de uma requisição de criação ou de listagem de notas e a API irá retornar as informações da nota correspondente.","operationId":"ConsultarNfse","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/Nfse"}}}}},"/nfse/{id}/cancelamento":{"get":{"tags":["Nfse"],"summary":"Consultar o cancelamento da NFS-e","operationId":"ConsultarCancelamentoNfse","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/NfseCancelamento"}}}},"post":{"tags":["Nfse"],"summary":"Cancelar uma NFS-e autorizada","description":"**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por requisição.","operationId":"CancelarNfse","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/NfsePedidoCancelamento"}},{"in":"path","name":"id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/NfseCancelamento"}}}}},"/nfse/{id}/pdf":{"get":{"tags":["Nfse"],"summary":"Baixar PDF do DANFSE","operationId":"BaixarPdfNfse","parameters":[{"in":"path","name":"id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"},{"in":"query","name":"logotipo","description":"Imprime o documento com logotipo, desde que esteja cadastrado na empresa.","type":"boolean","default":false},{"in":"query","name":"mensagem_rodape","description":"Imprime mensagem no rodapé do documento.\r\n\r\nO caractere `|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.\r\n\r\n**Exemplos de Uso:**\r\n* `\"esquerda\"`\r\n* `\"esquerda|centro\"`\r\n* `\"esquerda|centro|direita\"`\r\n* `\"|centro\"`, `\"|centro|\"`\r\n* `\"|centro|direita\"`\r\n* `\"||direita\"`\r\n* `\"esquerda||direita\"`\r\n\r\nDefault: `\"\"`","type":"string","maxLength":120}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfse/{id}/sincronizar":{"post":{"tags":["Nfse"],"summary":"Sincroniza dados na NFS-e a partir da Prefeitura","description":"Realiza a sincronização dos dados a partir da consulta da situação atual da NFS-e na prefeitura.\r\n\r\n**Cenários de uso**:\r\n* Sincronizar uma nota que se encontra com o status `processando` na API, mas está autorizada na prefeitura;\r\n* Sincronizar uma nota que se encontra com o status `erro` na API, mas está autorizada na prefeitura (útil em casos de erros de transmissão, como instabilidades e timeouts);\r\n* Sincronizar uma nota que se encontra com o status `autorizada`na API, mas está cancelada na prefeitura.\r\n\r\n**Informações adicionais**:\r\n- Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>\r\n- Consumo: 1 unidade por evento sincronizado ou requisição.","operationId":"SincronizarNfse","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/NfsePedidoSincronizacao"}},{"in":"path","name":"id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"$ref":"#/definitions/NfseSincronizacao"}}}}},"/nfse/{id}/xml":{"get":{"tags":["Nfse"],"summary":"Baixar XML da NFS-e processada","operationId":"BaixarXmlNfse","parameters":[{"in":"path","name":"id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}},"/nfse/{id}/xml/dps":{"get":{"tags":["Nfse"],"summary":"Baixar XML da DPS","operationId":"BaixarXmlDps","parameters":[{"in":"path","name":"id","description":"ID único da NFS-e gerado pela API.","required":true,"type":"string"}],"responses":{"200":{"description":"Successful response","schema":{"type":"file"}}}}}},"securityDefinitions":{"jwt":{"type":"apiKey","name":"Authorization","in":"header"},"oauth2":{"type":"oauth2","description":"Autenticação via OAuth 2.0","tokenUrl":"https://auth.nuvemfiscal.com.br/oauth/token","flow":"application","scopes":{"conta":"","empresa":"","cep":"","cnpj":"","mdfe":"","cte":"","nfse":"","nfe":""}}},"definitions":{"Empresa":{"type":"object","properties":{"cpf_cnpj":{"type":"string","description":"CPF ou CNPJ da empresa.\r\n\r\n*Utilize o valor sem máscara*."},"created_at":{"type":"string","format":"date-time","description":"Data/hora em que o objeto foi criado na API. Representado no formato <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"blank\">`ISO 8601`</a>.\r\n\r\n*A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado*."},"updated_at":{"type":"string","format":"date-time","description":"Data e hora que o objeto foi alterado pela última vez na API. Representado no formato <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"blank\">`ISO 8601`</a>.\r\n\r\n*A API gerencia esse campo automaticamente. Caso algum valor seja enviado, ele será ignorado*."},"inscricao_estadual":{"type":"string","description":"Inscrição estadual da empresa.","maxLength":50},"inscricao_municipal":{"type":"string","description":"Inscrição municipal da empresa.","maxLength":50},"nome_razao_social":{"type":"string","description":"Razão social da empresa.","maxLength":500},"nome_fantasia":{"type":"string","description":"Nome fantasia da empresa.","maxLength":500},"fone":{"type":"string","description":"Telefone da empresa."},"email":{"type":"string","description":"Email da empresa."},"endereco":{"$ref":"#/definitions/EmpresaEndereco"}},"required":["endereco","email","nome_razao_social","cpf_cnpj"]},"EmpresaEndereco":{"type":"object","description":"Endereço da empresa.","properties":{"logradouro":{"type":"string","description":"Logradouro.","maxLength":255},"numero":{"type":"string","description":"Número.","maxLength":255},"complemento":{"type":"string","description":"Complemento.","maxLength":500},"bairro":{"type":"string","description":"Bairro.","maxLength":255},"codigo_municipio":{"type":"string","description":"Código IBGE do município."},"cidade":{"type":"string","description":"Cidade.","maxLength":255},"uf":{"type":"string","description":"Sigla do estado."},"codigo_pais":{"type":"string","description":"Código do país.","default":"1058"},"pais":{"type":"string","description":"Nome do país.","default":"Brasil","maxLength":255},"cep":{"type":"string","description":"CEP.\r\n\r\n*Utilize o valor sem máscara*."}},"required":["cep","uf","codigo_municipio","bairro","numero","logradouro"]},"EmpresaListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/Empresa"}}}},"EmpresaCertificadoListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/EmpresaCertificado"}}}},"EmpresaCertificado":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"serial_number":{"type":"string"},"issuer_name":{"type":"string"},"not_valid_before":{"type":"string","format":"date-time"},"not_valid_after":{"type":"string","format":"date-time"},"thumbprint":{"type":"string"},"subject_name":{"type":"string"},"cpf_cnpj":{"type":"string"},"nome_razao_social":{"type":"string"}}},"EmpresaPedidoCadastroCertificado":{"type":"object","properties":{"certificado":{"type":"string","format":"byte","description":"Binário do certificado digital (.pfx ou .p12) codificado em base64."},"password":{"type":"string","description":"Senha do certificado."}},"required":["password","certificado"]},"EmpresaConfigNfe":{"type":"object","properties":{"CRT":{"type":"integer","description":"Código de Regime Tributário.\r\nEste campo será preenchido com:\r\n* 1 – Simples Nacional;\r\n* 2 – Simples Nacional – excesso de sublimite de receita bruta;\r\n* 3 – Regime Normal;\r\n* 4 - Simples Nacional - Microempreendedor individual (MEI).","default":3},"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente"]},"EmpresaConfigNfce":{"type":"object","properties":{"CRT":{"type":"integer","description":"Código de Regime Tributário.\r\nEste campo será preenchido com:\r\n* 1 – Simples Nacional;\r\n* 2 – Simples Nacional – excesso de sublimite de receita bruta;\r\n* 3 – Regime Normal;\r\n* 4 - Simples Nacional - Microempreendedor individual (MEI).","default":3},"sefaz":{"$ref":"#/definitions/EmpresaConfigNfceSefaz"},"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente","sefaz"]},"EmpresaConfigNfceSefaz":{"type":"object","properties":{"id_csc":{"type":"integer","description":"Número de identificação do CSC."},"csc":{"type":"string","description":"Código do CSC.","maxLength":50}},"required":["csc","id_csc"]},"EmpresaConfigNfse":{"type":"object","properties":{"regTrib":{"$ref":"#/definitions/EmpresaConfigNfseRegTrib"},"rps":{"$ref":"#/definitions/EmpresaConfigRps"},"prefeitura":{"$ref":"#/definitions/EmpresaConfigPrefeitura"},"incentivo_fiscal":{"type":"boolean","description":"Indicador se a empresa possui algum tipo de incentivo fiscal.","default":false},"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente","rps"]},"EmpresaConfigNfseRegTrib":{"type":"object","description":"Grupo de informações relativas aos regimes de tributação do prestador de serviços.","properties":{"opSimpNac":{"type":"integer","description":"Situação perante o Simples Nacional:\r\n* 1 - Não Optante;\r\n* 2 - Optante - Microempreendedor Individual (MEI);\r\n* 3 - Optante - Microempresa ou Empresa de Pequeno Porte (ME/EPP).","default":1,"x-nullable":true},"regApTribSN":{"type":"integer","description":"Opção para que o contribuinte optante pelo Simples Nacional ME/EPP (opSimpNac = 3) possa indicar, ao emitir o documento fiscal, em qual regime de apuração os tributos federais e municipal estão inseridos, caso tenha ultrapassado algum sublimite ou limite definido para o Simples Nacional.\r\n* 1 – Regime de apuração dos tributos federais e municipal pelo SN;\r\n* 2 – Regime de apuração dos tributos federais pelo SN e ISSQN  por fora do SN conforme respectiva legislação municipal do tributo;\r\n* 3 – Regime de apuração dos tributos federais e municipal por fora do SN conforme respectivas legilações federal e municipal de cada tributo.","x-nullable":true},"regEspTrib":{"type":"integer","description":"Regime Especial de Tributação (Padrão Nacional):\r\n* 0 - Nenhum;\r\n* 1 - Ato Cooperado (Cooperativa);\r\n* 2 - Estimativa;\r\n* 3 - Microempresa Municipal;\r\n* 4 - Notário ou Registrador;\r\n* 5 - Profissional Autônomo;\r\n* 6 - Sociedade de Profissionais.\r\n\r\n**Comportamento:**\r\n - Quando o envio for feito para o Ambiente Nacional, o valor é utilizado\r\n   exatamente como se apresenta, sem qualquer transformação ou mapeamento.\r\n - Quando o envio for feito diretamente para a prefeitura, o valor será\r\n   convertido internamente pela API para o código correspondente\r\n   esperado pela prefeitura, **se essa conversão for possível**.\r\n\r\n **Observação:** Em algumas prefeituras, existem códigos específicos que não têm\r\n correspondência direta no padrão nacional. Para lidar com esses casos, utilize\r\n o campo `prest.regTrib.regEspTrib` diretamente no endpoint de emissão de NFS-e.","default":0,"x-nullable":true}}},"EmpresaConfigRps":{"type":"object","description":"Configuração de numeração de lote, série e RPS.","properties":{"lote":{"type":"integer","format":"int64","description":"Número do Lote de RPS.\r\nInforme o próximo número do lote RPS a ser utilizado. Após isso, a Nuvem\r\nFiscal gerenciará esse campo (a cada novo envio de lote o número é\r\nincrementado em + 1). Portanto, basta informá-lo no cadastro da empresa\r\numa única vez."},"serie":{"type":"string","description":"Série do RPS.\r\nA série dos RPS varia de acordo com cada prefeitura, podendo ser\r\nnúmero (1, 2 ou 3, por exemplo) ou letras (A, S, NFS, por exemplo).\r\nPortanto, consulte-a com o município da empresa antes de iniciar a\r\nemissão das notas.","maxLength":20},"numero":{"type":"integer","format":"int64","description":"Número do RPS.\r\nInforme o próximo número de RPS a ser utilizado. Após isso, a Nuvem\r\nFiscal gerenciará esse campo (a cada novo envio de RPS o número é\r\nincrementado em + 1). Portanto, basta informá-lo no cadastro da empresa\r\numa única vez."}},"required":["numero","serie","lote"]},"EmpresaConfigPrefeitura":{"type":"object","description":"Dados adicionais para comunicação com a prefeitura. Essa validação é\r\ndinâmica, de acordo com a necessidade de cada município.","properties":{"login":{"type":"string","description":"Login de autenticação com a prefeitura, caso não utilize certificado digital.","maxLength":255},"senha":{"type":"string","description":"Senha de autenticação com a prefeitura, caso não utilize certificado digital.","maxLength":255},"token":{"type":"string","description":"Token de autenticação com a prefeitura, caso não utilize certificado digital.","maxLength":255}}},"EmpresaConfigMdfe":{"type":"object","properties":{"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente"]},"EmpresaConfigCte":{"type":"object","properties":{"CRT":{"type":"integer","description":"Código de Regime Tributário.\r\nEste campo será preenchido com:\r\n* 1 – Simples Nacional;\r\n* 2 – Simples Nacional – excesso de sublimite de receita bruta;\r\n* 3 – Regime Normal;\r\n* 4 - Simples Nacional - Microempreendedor Individual (MEI).","default":3},"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente"]},"EmpresaConfigCteOs":{"type":"object","properties":{"CRT":{"type":"integer","description":"Código de Regime Tributário.\r\nEste campo será preenchido com:\r\n* 1 – Simples Nacional;\r\n* 2 – Simples Nacional – excesso de sublimite de receita bruta;\r\n* 3 – Regime Normal;\r\n* 4 - Simples Nacional - Microempreendedor Individual (MEI).","default":3},"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente"]},"EmpresaConfigNfcom":{"type":"object","properties":{"CRT":{"type":"integer","description":"Código de Regime Tributário.\r\nEste campo será preenchido com:\r\n* 1 – Simples Nacional;\r\n* 2 – Simples Nacional – excesso de sublimite de receita bruta;\r\n* 3 – Regime Normal.","default":3},"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente"]},"EmpresaConfigDce":{"type":"object","properties":{"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente"]},"EmpresaConfigDistribuicaoNfe":{"type":"object","properties":{"distribuicao_automatica":{"type":"boolean","description":"Indica se a distribuição automática está habilitada.\r\n\r\nQuando ativada, a API realizará automaticamente pedidos de\r\ndistribuição de notas fiscais eletrônicas (NF-e) utilizando o último NSU.\r\n\r\nA frequência dessas distribuições é controlada pelo campo `distribuicao_intervalo_horas`,\r\ncujo valor padrão é 24 horas (uma vez ao dia).","default":false,"x-nullable":true},"distribuicao_intervalo_horas":{"type":"integer","description":"Define o intervalo mínimo, em horas, entre distribuições automáticas de documentos.\r\n\r\nEsse valor determina com que frequência a API executará novas\r\nrequisições automáticas de distribuição de notas fiscais eletrônicas (NF-e).\r\n\r\nDeve ser um valor entre 1 e 24. Por exemplo, se configurado como 4, uma nova\r\ntentativa de distribuição só será feita se pelo menos 4 horas tiverem se passado\r\ndesde a última requisição.\r\n\r\nEsse campo só é relevante quando `distribuicao_automatica` estiver habilitado.","default":24,"maximum":24,"minimum":1,"x-nullable":true},"ciencia_automatica":{"type":"boolean","description":"Indica se a manifestação de Ciência da Operação (210210) deve ser feita\r\nautomaticamente pela API.\r\n\r\nCaso habilitada, a manifestação de ciência será realizada para notas\r\nrecebidas por qualquer forma de consulta ou modo de distribuição (manual ou automático).","default":false,"x-nullable":true},"ambiente":{"type":"string","description":"Indica se a empresa irá emitir em produção ou homologação.","enum":["homologacao","producao"]}},"required":["ambiente"]},"DfeSefazStatus":{"type":"object","properties":{"autorizador":{"type":"string","description":"SEFAZ autorizadora responsável.","enum":["AM","BA","CE","GO","MG","MS","MT","PE","PR","RS","SP","SVAN","SVRS","SVCAN","SVCRS","AN","SVSP","SVCSP"]},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"data_hora_consulta":{"type":"string","format":"date-time","description":"Data e hora da consulta."},"codigo_status":{"type":"integer","description":"Código do status da mensagem enviada."},"motivo_status":{"type":"string","description":"Descrição literal do status do serviço solicitado."},"tempo_medio_resposta":{"type":"integer","description":"Tempo médio de resposta do serviço (em segundos) dos últimos 5 minutos.","x-nullable":true},"data_hora_retorno":{"type":"string","format":"date-time","description":"Data e hora prevista para o retorno dos serviços prestados.","x-nullable":true}}},"CteOsPedidoEmissao":{"type":"object","properties":{"infCte":{"$ref":"#/definitions/CteOsSefazInfCteOS"},"infCTeSupl":{"$ref":"#/definitions/CteOsSefazInfCTeSuplOS"},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true}},"required":["ambiente","infCte"]},"CteOsSefazInfCteOS":{"type":"object","description":"Informações do CT-e Outros Serviços.","properties":{"versao":{"type":"string","description":"Versão do leiaute.\r\nEx: \"4.00\".","x-nullable":true},"Id":{"type":"string","description":"Identificador da tag a ser assinada.\r\nInformar a chave de acesso do CT-e OS e precedida do literal \"CTe\".\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"ide":{"$ref":"#/definitions/CteOsSefazIdeOS"},"compl":{"$ref":"#/definitions/CteOsSefazComplOS"},"emit":{"$ref":"#/definitions/CteOsSefazEmitOS"},"toma":{"$ref":"#/definitions/CteOsSefazTomaOS"},"vPrest":{"$ref":"#/definitions/CteOsSefazVPrestOS"},"imp":{"$ref":"#/definitions/CteOsSefazInfCte_ImpOS"},"infCTeNorm":{"$ref":"#/definitions/CteOsSefazInfCTeNormOS"},"infCteComp":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazInfCteCompOS"},"maxItems":10},"autXML":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazAutXMLOS"},"maxItems":10},"infRespTec":{"$ref":"#/definitions/CteOsSefazRespTecOS"}},"required":["imp","vPrest","emit","ide","versao"]},"CteOsSefazIdeOS":{"type":"object","description":"Identificação do CT-e Outros Serviços.","properties":{"cUF":{"type":"integer","description":"Código da UF do emitente do CT-e.\r\nUtilizar a Tabela do IBGE.","x-nullable":true},"cCT":{"type":"string","description":"Código numérico que compõe a Chave de Acesso.\r\nNúmero aleatório gerado pelo emitente para cada CT-e, com o objetivo de evitar acessos indevidos ao documento.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"CFOP":{"type":"string","description":"Código Fiscal de Operações e Prestações.","x-nullable":true},"natOp":{"type":"string","description":"Natureza da Operação.","maxLength":60,"minLength":1,"x-nullable":true},"mod":{"type":"integer","description":"Modelo do documento fiscal.\r\nUtilizar o código 67 para identificação do CT-e Outros Serviços, emitido em substituição a Nota Fiscal Modelo 7 para transporte de pessoas, valores e excesso de bagagem.","x-nullable":true},"serie":{"type":"integer","description":"Série do CT-e OS.\r\nPreencher com \"0\" no caso de série única.","maximum":999,"minimum":0,"x-nullable":true},"nCT":{"type":"integer","description":"Número do CT-e OS.","maximum":999999999,"minimum":1,"x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e hora de emissão do CT-e OS.\r\nFormato AAAA-MM-DDTHH:MM:DD TZD.","x-nullable":true},"tpImp":{"type":"integer","description":"Formato de impressão do DACTE:\r\n* 1 - Retrato\r\n* 2 - Paisagem","x-nullable":true},"tpEmis":{"type":"integer","description":"Forma de emissão do CT-e.\r\nPreencher com:\r\n* 1 - Normal\r\n* 5 - Contingência FSDA\r\n* 7 - Autorização pela SVC-RS\r\n* 8 - Autorização pela SVC-SP","x-nullable":true},"cDV":{"type":"integer","description":"Digito Verificador da chave de acesso do CT-e.\r\nInformar o dígito  de controle da chave de acesso do CT-e, que deve ser calculado com a aplicação do algoritmo módulo 11 (base 2,9) da chave de acesso.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maximum":9,"minimum":0,"x-nullable":true},"tpAmb":{"type":"integer","description":"Tipo do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"tpCTe":{"type":"integer","description":"Tipo do CT-e OS.\r\nPreencher com:\r\n* 0 - CT-e Normal\r\n* 1 - CT-e Complementar\r\n* 3 - CT-e de Substituição","x-nullable":true},"procEmi":{"type":"integer","description":"Identificador do processo de emissão do CT-e OS.\r\nPreencher com:\r\n* 0 - emissão de CT-e com aplicativo do contribuinte\r\n* 3 - emissão CT-e pelo contribuinte com aplicativo fornecido pelo Fisco","x-nullable":true},"verProc":{"type":"string","description":"Versão do processo de emissão.\r\nIinformar a versão do aplicativo emissor de CT-e.","maxLength":20,"minLength":1,"x-nullable":true},"cMunEnv":{"type":"string","description":"Código do Município de envio do CT-e (de onde o documento foi transmitido).\r\nUtilizar a tabela do IBGE. Informar 9999999 para as operações com o exterior.","x-nullable":true},"xMunEnv":{"type":"string","description":"Nome do Município de envio do CT-e (de onde o documento foi transmitido).\r\nInformar PAIS/Municipio para as operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UFEnv":{"type":"string","description":"Sigla da UF de envio do CT-e (de onde o documento foi transmitido).\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"modal":{"type":"string","description":"Modal. Preencher com:\r\n* 01 - Rodoviário\r\n* 02 - Aéreo\r\n* 03 - Aquaviário\r\n* 04 - Ferroviário","x-nullable":true},"tpServ":{"type":"integer","description":"Tipo do Serviço.\r\nPreencher com:\r\n* 6 - Transporte de Pessoas\r\n* 7 - Transporte de Valores\r\n* 8 - Excesso de Bagagem","x-nullable":true},"indIEToma":{"type":"integer","description":"Indicador da IE do tomador:\r\n* 1 - Contribuinte ICMS\r\n* 2 - Contribuinte isento de inscrição\r\n* 9 - Não Contribuinte\r\nAplica-se ao tomador que for indicado no toma3 ou toma4.","x-nullable":true},"cMunIni":{"type":"string","description":"Código do Município de início da prestação.\r\nUtilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.","x-nullable":true},"xMunIni":{"type":"string","description":"Nome do Município do início da prestação.\r\nInformar 'EXTERIOR' para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UFIni":{"type":"string","description":"UF do início da prestação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"cMunFim":{"type":"string","description":"Código do Município de término da prestação.\r\nUtilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.","x-nullable":true},"xMunFim":{"type":"string","description":"Nome do Município do término da prestação.\r\nInformar 'EXTERIOR' para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UFFim":{"type":"string","description":"UF do término da prestação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"infPercurso":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazInfPercursoOS"},"maxItems":25},"dhCont":{"type":"string","format":"date-time","description":"Data e Hora da entrada em contingência.\r\nInformar a data e hora no formato AAAA-MM-DDTHH:MM:SS.","x-nullable":true},"xJust":{"type":"string","description":"Justificativa da entrada em contingência.","maxLength":256,"minLength":15,"x-nullable":true},"gCompraGov":{"$ref":"#/definitions/CteOsSefazCompraGovReduzidoOS"}},"required":["indIEToma","tpServ","modal","UFEnv","xMunEnv","cMunEnv","verProc","procEmi","tpCTe","tpEmis","tpImp","dhEmi","nCT","serie","natOp","CFOP","cUF"]},"CteOsSefazInfPercursoOS":{"type":"object","description":"Informações do Percurso do CT-e Outros Serviços.","properties":{"UFPer":{"type":"string","description":"Sigla das Unidades da Federação do percurso do veículo.\r\nNão é necessário repetir as UF de Início e Fim.","x-nullable":true}},"required":["UFPer"]},"CteOsSefazCompraGovReduzidoOS":{"type":"object","description":"Grupo de Compras Governamentais.","properties":{"tpEnteGov":{"type":"integer","description":"Para administração pública direta e suas autarquias e fundações:\r\n* 1 - União\r\n* 2 - Estados\r\n* 3 - Distrito Federal\r\n* 4 - Municípios","x-nullable":true},"pRedutor":{"type":"number","description":"Percentual de redução de aliquota em compra governamental.","minimum":0,"x-nullable":true}},"required":["pRedutor","tpEnteGov"]},"CteOsSefazComplOS":{"type":"object","description":"Dados complementares do CT-e para fins operacionais ou comerciais.","properties":{"xCaracAd":{"type":"string","description":"Característica adicional do transporte.\r\nTexto livre:\r\nREENTREGA\r\nDEVOLUÇÃO\r\nREFATURAMENTO\r\netc.","maxLength":15,"minLength":1,"x-nullable":true},"xCaracSer":{"type":"string","description":"Característica adicional do serviço.\r\nTexto livre:\r\nENTREGA EXPRESSA\r\nLOGÍSTICA REVERSA\r\nCONVENCIONAL\r\nEMERGENCIAL\r\netc.","maxLength":30,"minLength":1,"x-nullable":true},"xEmi":{"type":"string","description":"Funcionário emissor do CTe.","maxLength":20,"minLength":1,"x-nullable":true},"xObs":{"type":"string","description":"Observações Gerais.","maxLength":2000,"minLength":1,"x-nullable":true},"ObsCont":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazObsContOS"},"maxItems":10},"ObsFisco":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazObsFiscoOS"},"maxItems":10}}},"CteOsSefazObsContOS":{"type":"object","description":"Campo de uso livre do contribuinte.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no XTexto.","properties":{"xCampo":{"type":"string","description":"Identificação do campo.","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do campo.","maxLength":160,"minLength":1,"x-nullable":true}},"required":["xTexto","xCampo"]},"CteOsSefazObsFiscoOS":{"type":"object","description":"Campo de uso livre do contribuinte.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no XTexto.","properties":{"xCampo":{"type":"string","description":"Identificação do campo.","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do campo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTexto","xCampo"]},"CteOsSefazEmitOS":{"type":"object","description":"Identificação do Emitente do CT-e OS.","properties":{"CNPJ":{"type":"string","description":"CNPJ do emitente.\r\nInformar zeros não significativos.\r\n\r\n***Obrigatório caso o emitente seja pessoa jurídica***.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual do Emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"IEST":{"type":"string","description":"Inscrição Estadual do Substituto Tributário.","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou Nome do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"enderEmit":{"$ref":"#/definitions/CteOsSefazEndeEmiOS"},"CRT":{"type":"integer","description":"Código do Regime Tributário. Informar:\r\n* 1 - Simples Nacional;\r\n* 2 - Simples Nacional, excesso sublimite de receita bruta;\r\n* 3 - Regime Normal;\r\n* 4 - Simples Nacional - Microempreendedor Individual (MEI).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"CteOsSefazEndeEmiOS":{"type":"object","description":"Endereço do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","properties":{"xLgr":{"type":"string","description":"Logradouro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"fone":{"type":"string","description":"Telefone.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"CteOsSefazTomaOS":{"type":"object","description":"Informações do Tomador/Usuário do Serviço.\r\nOpcional para Excesso de Bagagem.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.\r\nInformar a IE do tomador ou ISENTO se tomador é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o tomador não seja contribuinte do ICMS não informar o conteúdo.","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou nome do tomador.","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"enderToma":{"$ref":"#/definitions/CteOsSefazEnderecoOS"},"email":{"type":"string","description":"Endereço de email.","x-nullable":true}},"required":["enderToma","xNome"]},"CteOsSefazEnderecoOS":{"type":"object","description":"Dados do endereço.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":255,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\nInformar 9999999 para operações com o exterior.","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\nInformar EXTERIOR para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar os zeros não significativos.","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true},"cPais":{"type":"string","description":"Código do país.\r\nUtilizar a tabela do BACEN.","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["UF","xMun","cMun","xBairro","nro","xLgr"]},"CteOsSefazVPrestOS":{"type":"object","description":"Valores da Prestação de Serviço.","properties":{"vTPrest":{"type":"number","description":"Valor Total da Prestação do Serviço.\r\nPode conter zeros quando o CT-e for de complemento de ICMS.","minimum":0,"x-nullable":true},"vRec":{"type":"number","description":"Valor a Receber.","minimum":0,"x-nullable":true},"Comp":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazCompOS"}}},"required":["vRec","vTPrest"]},"CteOsSefazCompOS":{"type":"object","description":"Componentes do Valor da Prestação.","properties":{"xNome":{"type":"string","description":"Nome do componente.\r\nExxemplos: FRETE PESO, FRETE VALOR, SEC/CAT, ADEME, AGENDAMENTO, etc.","maxLength":15,"minLength":1,"x-nullable":true},"vComp":{"type":"number","description":"Valor do componente.","minimum":0,"x-nullable":true}},"required":["vComp","xNome"]},"CteOsSefazInfCte_ImpOS":{"type":"object","description":"Informações relativas aos Impostos.","properties":{"ICMS":{"$ref":"#/definitions/CteOsSefazImpOS"},"vTotTrib":{"type":"number","description":"Valor Total dos Tributos.","minimum":0,"x-nullable":true},"infAdFisco":{"type":"string","description":"Informações adicionais de interesse do Fisco.\r\nNorma referenciada, informações complementares, etc.","maxLength":2000,"minLength":1,"x-nullable":true},"ICMSUFFim":{"$ref":"#/definitions/CteOsSefazICMSUFFimOS"},"infTribFed":{"$ref":"#/definitions/CteOsSefazInfTribFedOS"},"IBSCBS":{"$ref":"#/definitions/CteOsSefazTribCTeOS"},"vTotDFe":{"type":"number","description":"Valor total do documento fiscal\r\n(vTPrest + total do IBS + total da CBS).","minimum":0,"x-nullable":true}},"required":["ICMS"]},"CteOsSefazImpOS":{"type":"object","description":"Informações relativas ao ICMS.","properties":{"ICMS00":{"$ref":"#/definitions/CteOsSefazICMS00OS"},"ICMS20":{"$ref":"#/definitions/CteOsSefazICMS20OS"},"ICMS45":{"$ref":"#/definitions/CteOsSefazICMS45OS"},"ICMS90":{"$ref":"#/definitions/CteOsSefazICMS90OS"},"ICMSOutraUF":{"$ref":"#/definitions/CteOsSefazICMSOutraUFOS"},"ICMSSN":{"$ref":"#/definitions/CteOsSefazICMSSNOS"}}},"CteOsSefazICMS00OS":{"type":"object","description":"Prestação sujeito à tributação normal do ICMS.","properties":{"CST":{"type":"string","description":"classificação Tributária do Serviço.\r\n* 00 - tributação normal ICMS","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true}},"required":["vICMS","pICMS","vBC","CST"]},"CteOsSefazICMS20OS":{"type":"object","description":"Prestação sujeito à tributação com redução de BC do ICMS.","properties":{"CST":{"type":"string","description":"Classificação Tributária do serviço.\r\n* 20 - tributação com BC reduzida do ICMS","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMS","pICMS","vBC","pRedBC","CST"]},"CteOsSefazICMS45OS":{"type":"object","description":"ICMS  Isento, não Tributado ou diferido.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\nPreencher com:\r\n* 40 - ICMS isenção\r\n* 41 - ICMS não tributada\r\n* 51 - ICMS diferido","x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["CST"]},"CteOsSefazICMS90OS":{"type":"object","description":"ICMS Outros.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - Outros","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vCred":{"type":"number","description":"Valor do Crédito Outorgado/Presumido.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMS","pICMS","vBC","CST"]},"CteOsSefazICMSOutraUFOS":{"type":"object","description":"ICMS devido à UF de origem da prestação, quando  diferente da UF do emitente.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS Outra UF","x-nullable":true},"pRedBCOutraUF":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBCOutraUF":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMSOutraUF":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMSOutraUF":{"type":"number","description":"Valor do ICMS devido outra UF.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMSOutraUF","pICMSOutraUF","vBCOutraUF","CST"]},"CteOsSefazICMSSNOS":{"type":"object","description":"Simples Nacional.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS Simples Nacional","x-nullable":true},"indSN":{"type":"integer","description":"Indica se o contribuinte é Simples Nacional\t\t\t1=Sim.","x-nullable":true}},"required":["indSN","CST"]},"CteOsSefazICMSUFFimOS":{"type":"object","description":"Informações do ICMS de partilha com a UF de término do serviço de transporte na operação interestadual.\r\nGrupo a ser informado nas prestações interestaduais para consumidor final, não contribuinte do ICMS.","properties":{"vBCUFFim":{"type":"number","description":"Valor da BC do ICMS na UF de término da prestação do serviço de transporte.","minimum":0,"x-nullable":true},"pFCPUFFim":{"type":"number","description":"Percentual do ICMS relativo ao Fundo de Combate à pobreza (FCP) na UF de término da prestação do serviço de transporte.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"pICMSUFFim":{"type":"number","description":"Alíquota interna da UF de término da prestação do serviço de transporte.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"pICMSInter":{"type":"number","description":"Alíquota interestadual das UF envolvidas.\r\nAlíquota interestadual das UF envolvidas.","minimum":0,"x-nullable":true},"vFCPUFFim":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate á Pobreza (FCP) da UF de término da prestação.","minimum":0,"x-nullable":true},"vICMSUFFim":{"type":"number","description":"Valor do ICMS de partilha para a UF de término da prestação do serviço de transporte.","minimum":0,"x-nullable":true},"vICMSUFIni":{"type":"number","description":"Valor do ICMS de partilha para a UF de início da prestação do serviço de transporte.","minimum":0,"x-nullable":true}},"required":["vICMSUFIni","vICMSUFFim","vFCPUFFim","pICMSInter","pICMSUFFim","pFCPUFFim","vBCUFFim"]},"CteOsSefazInfTribFedOS":{"type":"object","description":"Informações dos tributos federais.\r\nGrupo a ser informado nas prestações interestaduais para consumidor final, não contribuinte do ICMS.","properties":{"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor COFINS.","minimum":0,"x-nullable":true},"vIR":{"type":"number","description":"Valor de Imposto de Renda.","minimum":0,"x-nullable":true},"vINSS":{"type":"number","description":"Valor do INSS.","minimum":0,"x-nullable":true},"vCSLL":{"type":"number","description":"Valor do CSLL.","minimum":0,"x-nullable":true}}},"CteOsSefazTribCTeOS":{"type":"object","description":"Grupo de informações do IBS e CBS.","properties":{"CST":{"type":"string","description":"Código Situação Tributária do IBS/CBS.","x-nullable":true},"cClassTrib":{"type":"string","x-nullable":true},"indDoacao":{"type":"integer","x-nullable":true},"gIBSCBS":{"$ref":"#/definitions/CteOsSefazCIBSOS"},"gEstornoCred":{"$ref":"#/definitions/CteOsSefazEstornoCredOS"}},"required":["CST"]},"CteOsSefazCIBSOS":{"type":"object","properties":{"vBC":{"type":"number","description":"Valor do BC.","minimum":0,"x-nullable":true},"gIBSUF":{"$ref":"#/definitions/CteOsSefazGIBSUFOS"},"gIBSMun":{"$ref":"#/definitions/CteOsSefazGIBSMunOS"},"vIBS":{"type":"number","description":"Valor do IBS.","minimum":0,"x-nullable":true},"gCBS":{"$ref":"#/definitions/CteOsSefazGCBSOS"},"gTribRegular":{"$ref":"#/definitions/CteOsSefazTribRegularOS"},"gTribCompraGov":{"$ref":"#/definitions/CteOsSefazTribCompraGovOS"}},"required":["gCBS","vIBS","gIBSMun","gIBSUF","vBC"]},"CteOsSefazGIBSUFOS":{"type":"object","description":"Grupo de informações do IBS na UF.","properties":{"pIBSUF":{"type":"number","description":"Aliquota do IBS de competência das UF (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteOsSefazDifOS"},"gDevTrib":{"$ref":"#/definitions/CteOsSefazDevTribOS"},"gRed":{"$ref":"#/definitions/CteOsSefazRedOS"},"vIBSUF":{"type":"number","description":"Valor do IBS de competência das UF.","minimum":0,"x-nullable":true}},"required":["vIBSUF","pIBSUF"]},"CteOsSefazDifOS":{"type":"object","description":"Grupo de campos do Diferimento.","properties":{"pDif":{"type":"number","description":"Percentual do diferimento.","minimum":0,"x-nullable":true},"vDif":{"type":"number","description":"Valor do diferimento.","minimum":0,"x-nullable":true}},"required":["vDif","pDif"]},"CteOsSefazDevTribOS":{"type":"object","description":"Grupo de Informações da devolução de tributos.","properties":{"vDevTrib":{"type":"number","description":"Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e\r\ngás natural e em outras hipóteses definidas no regulamento.","minimum":0,"x-nullable":true}},"required":["vDevTrib"]},"CteOsSefazRedOS":{"type":"object","description":"Grupo de campos da redução de aliquota.","properties":{"pRedAliq":{"type":"number","description":"Percentual de redução de aliquota do cClassTrib.","minimum":0,"x-nullable":true},"pAliqEfet":{"type":"number","description":"Aliquota Efetiva que será aplicada a Base de Calculo (em percentual).","minimum":0,"x-nullable":true}},"required":["pAliqEfet","pRedAliq"]},"CteOsSefazGIBSMunOS":{"type":"object","description":"Grupo de Informações do IBS no Município.","properties":{"pIBSMun":{"type":"number","description":"Aliquota do IBS Municipal (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteOsSefazDifOS"},"gDevTrib":{"$ref":"#/definitions/CteOsSefazDevTribOS"},"gRed":{"$ref":"#/definitions/CteOsSefazRedOS"},"vIBSMun":{"type":"number","description":"Valor do IBS Municipal.","minimum":0,"x-nullable":true}},"required":["vIBSMun","pIBSMun"]},"CteOsSefazGCBSOS":{"type":"object","description":"Grupo de Tributação da CBS.","properties":{"pCBS":{"type":"number","description":"Aliquota da CBS (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteOsSefazDifOS"},"gDevTrib":{"$ref":"#/definitions/CteOsSefazDevTribOS"},"gRed":{"$ref":"#/definitions/CteOsSefazRedOS"},"vCBS":{"type":"number","description":"Valor da CBS.","minimum":0,"x-nullable":true}},"required":["vCBS","pCBS"]},"CteOsSefazTribRegularOS":{"type":"object","description":"Grupo de informações da Tributação Regular. Informar como seria a tributação caso não cumprida a condição resolutória/suspensiva. Exemplo 1: Art. 442, §4. Operações com ZFM e ALC. Exemplo 2: Operações com suspensão do tributo.","properties":{"CSTReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS.\r\nInformar qual seria o CST caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"cClassTribReg":{"type":"string","description":"Informar qual seria o cClassTrib caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"pAliqEfetRegIBSUF":{"type":"number","description":"Alíquota do IBS da UF.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSUF":{"type":"number","description":"Valor do IBS da UF.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegIBSMun":{"type":"number","description":"Alíquota do IBS do Município.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSMun":{"type":"number","description":"Valor do IBS do Município.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegCBS":{"type":"number","description":"Alíquota da CBS.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegCBS":{"type":"number","description":"Valor da CBS.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true}},"required":["vTribRegCBS","pAliqEfetRegCBS","vTribRegIBSMun","pAliqEfetRegIBSMun","vTribRegIBSUF","pAliqEfetRegIBSUF","cClassTribReg","CSTReg"]},"CteOsSefazTribCompraGovOS":{"type":"object","description":"Grupo de informações da composição do valor do IBS e da CBS em compras governamental.","properties":{"pAliqIBSUF":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSUF":{"type":"number","description":"Valor que seria devido a UF, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqIBSMun":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSMun":{"type":"number","description":"Valor que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqCBS":{"type":"number","minimum":0,"x-nullable":true},"vTribCBS":{"type":"number","description":"Valor que seria devido a CBS, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true}},"required":["vTribCBS","vTribIBSMun","vTribIBSUF"]},"CteOsSefazEstornoCredOS":{"type":"object","description":"Informado conforme indicador no cClassTrib.","properties":{"vIBSEstCred":{"type":"number","description":"Valor do IBS a ser estornado.","minimum":0,"x-nullable":true},"vCBSEstCred":{"type":"number","description":"Valor da CBS a ser estornada.","minimum":0,"x-nullable":true}},"required":["vCBSEstCred","vIBSEstCred"]},"CteOsSefazInfCTeNormOS":{"type":"object","description":"Grupo de informações do CT-e OS Normal.","properties":{"infServico":{"$ref":"#/definitions/CteOsSefazInfServicoOS"},"infDocRef":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazInfDocRefOS"}},"seg":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazSegOS"}},"infModal":{"$ref":"#/definitions/CteOsSefazInfModalOS"},"infCteSub":{"$ref":"#/definitions/CteOsSefazInfCteSubOS"},"refCTeCanc":{"type":"string","description":"Chave de acesso do CT-e Cancelado\r\nSomente para Transporte de Valores.","x-nullable":true},"cobr":{"$ref":"#/definitions/CteOsSefazCobrOS"},"infGTVe":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazInfGTVeOS"}}},"required":["infServico"]},"CteOsSefazInfServicoOS":{"type":"object","description":"Informações da Prestação do Serviço.","properties":{"xDescServ":{"type":"string","description":"Descrição do Serviço prestado.","maxLength":30,"minLength":1,"x-nullable":true},"infQ":{"$ref":"#/definitions/CteOsSefazInfQOS"}},"required":["xDescServ"]},"CteOsSefazInfQOS":{"type":"object","description":"Informações de quantidades da Carga do CT-e.\r\nPara Transporte de Pessoas indicar número de passageiros, para excesso de bagagem e transporte de valores indicar número de Volumes/Malotes.","properties":{"qCarga":{"type":"number","description":"Quantidade.","minimum":0,"x-nullable":true}},"required":["qCarga"]},"CteOsSefazInfDocRefOS":{"type":"object","description":"Informações dos documentos referenciados.","properties":{"nDoc":{"type":"string","description":"Número.","maxLength":20,"minLength":1,"x-nullable":true},"serie":{"type":"string","description":"Série.","maxLength":3,"minLength":1,"x-nullable":true},"subserie":{"type":"string","description":"Subsérie.","maxLength":3,"minLength":1,"x-nullable":true},"dEmi":{"type":"string","format":"date","description":"Data de Emissão.\r\nFormato AAAA-MM-DD.","x-nullable":true},"vDoc":{"type":"number","description":"Valor Transportado.","minimum":0,"x-nullable":true},"chBPe":{"type":"string","description":"Chave de acesso do BP-e que possui eventos excesso de bagagem.","x-nullable":true}}},"CteOsSefazSegOS":{"type":"object","description":"Informações de Seguro da Carga.","properties":{"respSeg":{"type":"integer","description":"Responsável pelo seguro.\r\nPreencher com:\r\n* 4 - Emitente do CT-e\r\n* 5 - Tomador de Serviço","x-nullable":true},"xSeg":{"type":"string","description":"Nome da Seguradora.","maxLength":30,"minLength":1,"x-nullable":true},"nApol":{"type":"string","description":"Número da Apólice.\r\nObrigatório pela lei 11.442/07 (RCTRC).","maxLength":20,"minLength":1,"x-nullable":true}},"required":["respSeg"]},"CteOsSefazInfModalOS":{"type":"object","description":"Informações do modal\r\nObrigatório para Pessoas e Bagagem.","properties":{"versaoModal":{"type":"string","description":"Versão do leiaute específico para o Modal.","x-nullable":true},"rodoOS":{"$ref":"#/definitions/CteOsSefazRodoOS"}},"required":["versaoModal"]},"CteOsSefazRodoOS":{"type":"object","description":"Informações do modal Rodoviário.","properties":{"TAF":{"type":"string","description":"Termo de Autorização de Fretamento - TAF.\r\nRegistro obrigatório do emitente do CT-e OS junto à ANTT, de acordo com a Resolução ANTT nº 4.777/2015.","maxLength":12,"x-nullable":true},"NroRegEstadual":{"type":"string","description":"Número do Registro Estadual.\r\nRegistro obrigatório do emitente do CT-e OS junto à Agência Reguladora  Estadual.","maxLength":25,"x-nullable":true},"veic":{"$ref":"#/definitions/CteOsSefazVeicOS"},"infFretamento":{"$ref":"#/definitions/CteOsSefazInfFretamentoOS"}}},"CteOsSefazVeicOS":{"type":"object","description":"Dados do Veículo.","properties":{"placa":{"type":"string","description":"Placa do veículo.","x-nullable":true},"RENAVAM":{"type":"string","description":"RENAVAM do veículo.","maxLength":11,"minLength":9,"x-nullable":true},"prop":{"$ref":"#/definitions/CteOsSefazPropOS"},"UF":{"type":"string","description":"UF em que veículo está licenciado.\r\nSigla da UF de licenciamento do veículo.","x-nullable":true}},"required":["placa"]},"CteOsSefazPropOS":{"type":"object","description":"Proprietário ou possuidor do Veículo.\r\nSó preenchido quando o veículo não pertencer à empresa emitente do CT-e OS.","properties":{"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar os zeros não significativos.","x-nullable":true},"TAF":{"type":"string","description":"Termo de Autorização de Fretamento - TAF.\r\nDe acordo com a Resolução ANTT nº 4.777/2015.","maxLength":12,"x-nullable":true},"NroRegEstadual":{"type":"string","description":"Número do Registro Estadual.\r\nRegistro obrigatório do emitente do CT-e OS junto à Agência Reguladora  Estadual.","maxLength":25,"x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do proprietário.","maxLength":60,"minLength":2,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","x-nullable":true},"UF":{"type":"string","description":"UF.","x-nullable":true},"tpProp":{"type":"integer","description":"Tipo Proprietário ou possuidor.\r\nPreencher com:\r\n* 0 - TAC - Agregado\r\n* 1 - TAC Independente\r\nou\r\n* 2 - Outros","x-nullable":true}},"required":["tpProp","xNome"]},"CteOsSefazInfFretamentoOS":{"type":"object","description":"Dados do fretamento (apenas para Transporte de Pessoas).","properties":{"tpFretamento":{"type":"integer","description":"Tipo Fretamento.\r\nPreencher com:\r\n* 1 - Eventual 2 - Continuo","x-nullable":true},"dhViagem":{"type":"string","format":"date-time","description":"Data e hora da viagem (Apenas para fretamento eventual).\r\nFormato AAAA-MM-DDTHH:MM:DD TZD.","x-nullable":true}},"required":["tpFretamento"]},"CteOsSefazInfCteSubOS":{"type":"object","description":"Informações do CT-e de substituição.","properties":{"chCte":{"type":"string","description":"Chave de acesso do CT-e a ser substituído (original).","x-nullable":true}},"required":["chCte"]},"CteOsSefazCobrOS":{"type":"object","description":"Dados da cobrança do CT-e.","properties":{"fat":{"$ref":"#/definitions/CteOsSefazFatOS"},"dup":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazDupOS"}}}},"CteOsSefazFatOS":{"type":"object","description":"Dados da fatura.","properties":{"nFat":{"type":"string","description":"Número da fatura.","maxLength":60,"minLength":1,"x-nullable":true},"vOrig":{"type":"number","description":"Valor original da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDesc":{"type":"number","description":"Valor do desconto da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vLiq":{"type":"number","description":"Valor líquido da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}}},"CteOsSefazDupOS":{"type":"object","description":"Dados das duplicatas.","properties":{"nDup":{"type":"string","description":"Número da duplicata.","maxLength":60,"minLength":1,"x-nullable":true},"dVenc":{"type":"string","format":"date","description":"Data de vencimento da duplicata (AAAA-MM-DD).","x-nullable":true},"vDup":{"type":"number","description":"Valor da duplicata.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}}},"CteOsSefazInfGTVeOS":{"type":"object","description":"Informações das GTV-e relacionadas ao CT-e OS.","properties":{"chCTe":{"type":"string","description":"Chave de acesso da GTV-e.","x-nullable":true},"Comp":{"type":"array","items":{"$ref":"#/definitions/CteOsSefazInfGTVe_CompOS"},"minItems":1}},"required":["Comp","chCTe"]},"CteOsSefazInfGTVe_CompOS":{"type":"object","description":"Componentes do Valor da GTVe.","properties":{"tpComp":{"type":"integer","description":"Tipo do Componente.\r\n* 1 - Custodia\r\n* 2 - Embarque\r\n* 3 - Tempo de espera\r\n* 4 - Malote\r\n* 5 - Ad Valorem\r\n* 6 - Outros","x-nullable":true},"vComp":{"type":"number","description":"Valor do componente.","minimum":0,"x-nullable":true},"xComp":{"type":"string","description":"Nome do componente (informar apenas para outros).\r\nExemplos: FRETE PESO, FRETE VALOR, SEC/CAT, ADEME, AGENDAMENTO, etc.","maxLength":15,"minLength":0,"x-nullable":true}},"required":["vComp","tpComp"]},"CteOsSefazInfCteCompOS":{"type":"object","description":"Detalhamento do CT-e complementado.","properties":{"chCTe":{"type":"string","description":"Chave do CT-e complementado.","maxLength":44,"x-nullable":true}},"required":["chCTe"]},"CteOsSefazAutXMLOS":{"type":"object","description":"Autorizados para download do XML do DF-e.\r\nInformar CNPJ ou CPF. Preencher os zeros não significativos.","properties":{"CNPJ":{"type":"string","description":"CNPJ do autorizado.\r\nInformar zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"CPF do autorizado.\r\nInformar zeros não significativos.","x-nullable":true}}},"CteOsSefazRespTecOS":{"type":"object","description":"Informações do Responsável Técnico pela emissão do DF-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ da pessoa jurídica responsável técnica pelo sistema utilizado na emissão do documento fiscal eletrônico.\r\nInformar o CNPJ da pessoa jurídica desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico.","x-nullable":true},"xContato":{"type":"string","description":"Nome da pessoa a ser contatada.\r\nInformar o nome da pessoa a ser contatada na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico. No caso de pessoa física, informar o respectivo nome.","maxLength":60,"minLength":2,"x-nullable":true},"email":{"type":"string","description":"Email da pessoa jurídica a ser contatada.","maxLength":60,"minLength":1,"x-nullable":true},"fone":{"type":"string","description":"Telefone da pessoa jurídica a ser contatada.\r\nPreencher com o Código DDD + número do telefone.","x-nullable":true},"idCSRT":{"type":"integer","description":"Identificador do código de segurança do responsável técnico.\r\nIdentificador do CSRT utilizado para geração do hash.","maximum":999,"minimum":0,"x-nullable":true},"CSRT":{"type":"string","description":"Código de Segurança do Responsável Técnico utilizado para montar o hash do CSRT.","x-nullable":true},"hashCSRT":{"type":"string","description":"Hash do token do código de segurança do responsável técnico.\r\nO hashCSRT é o resultado das funções SHA-1 e base64 do token CSRT fornecido pelo fisco + chave de acesso do DF-e. (Implementação em futura NT)\r\nObservação: 28 caracteres são representados no schema como 20 bytes do tipo base64Binary.\r\n\r\n*Se não informado, será calculado automaticamente, desde que os campos `idCSRT` e `CSRT` sejam fornecidos.*","maxLength":28,"x-nullable":true}},"required":["fone","email","xContato","CNPJ"]},"CteOsSefazInfCTeSuplOS":{"type":"object","description":"Informações suplementares do CT-e.","properties":{"qrCodCTe":{"type":"string","description":"Texto com o QR-Code impresso no DACTE.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":1000,"minLength":50,"x-nullable":true}}},"Dfe":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para este documento."},"ambiente":{"type":"string","enum":["homologacao","producao"]},"created_at":{"type":"string","format":"date-time","description":"Data/hora em que o documento foi criado na API. Representado no formato <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"blank\">`ISO 8601`</a>."},"status":{"type":"string","description":"* `pendente`: o pedido de emissão do documento foi recebido pela API e está na fila de processamento.\r\n* `autorizado`, `rejeitado` ou `denegado`: o documento foi transmitido para a SEFAZ, que retornou um desses status.\r\n* `cancelado`: um evento de cancelamento foi homologado pela SEFAZ e associado ao documento.\r\n* `encerrado`: um evento de encerramento foi homologado pela SEFAZ e associado a um MDF-e.\r\n* `erro`: status próprio da API que significa, na maioria das vezes, que houve algum erro que impediu a transmissão do documento para a SEFAZ (erros de validação, erros interno do servidor, timeouts, etc).","enum":["pendente","autorizado","rejeitado","denegado","encerrado","cancelado","erro"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","x-nullable":true},"data_emissao":{"type":"string","format":"date-time"},"modelo":{"type":"integer"},"serie":{"type":"integer"},"numero":{"type":"integer"},"tipo_emissao":{"type":"integer"},"valor_total":{"type":"number"},"chave":{"type":"string","description":"Chave de acesso do DF-e."},"autorizacao":{"$ref":"#/definitions/DfeAutorizacao","description":"Protocolo de status resultado do processamento do DF-e."}}},"DfeAutorizacao":{"type":"object","properties":{"digest_value":{"type":"string","description":"Digest Value do DF-e processado. Utilizado para conferir a integridade do DF-e original."},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"DfeAutorEvento":{"type":"object","properties":{"cpf_cnpj":{"type":"string","description":"CPF/CNPJ do Autor."}}},"DfeListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/Dfe"}}}},"CteOsPedidoCancelamento":{"type":"object","properties":{"justificativa":{"type":"string","description":"Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco."}}},"DfeCancelamento":{"type":"object","properties":{"justificativa":{"type":"string","description":"Justificativa do cancelamento."},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"CteOsPedidoCartaCorrecao":{"type":"object","properties":{"correcoes":{"type":"array","description":"Grupo de Informações de Correção.","items":{"$ref":"#/definitions/CteOsInfCorrecao"},"minItems":1}},"required":["correcoes"]},"CteOsInfCorrecao":{"type":"object","properties":{"grupo_alterado":{"type":"string","description":"Indicar o grupo de informações que pertence o \"campo_alterado\". Ex: ide.","maxLength":20,"minLength":1},"campo_alterado":{"type":"string","description":"Nome do campo modificado do CT-e OS Original.","maxLength":20,"minLength":1},"valor_alterado":{"type":"string","description":"Valor correspondente à alteração.","maxLength":500,"minLength":1},"numero_item_alterado":{"type":"integer","description":"Preencher com o indice do item alterado caso a alteração ocorra em uma lista.\r\nOBS: O indice inicia sempre em 1.","x-nullable":true}},"required":["valor_alterado","campo_alterado","grupo_alterado"]},"CteOsCartaCorrecao":{"type":"object","properties":{"correcoes":{"type":"array","description":"Grupo de Informações de Correção.","items":{"$ref":"#/definitions/CteOsInfCorrecao"},"minItems":1},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}},"required":["correcoes"]},"DfeEvento":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"DfeSincronizacao":{"type":"object","properties":{"status":{"type":"string","description":"Situação atual da sincronização.","enum":["pendente","sincronizado","erro"]},"codigo_status":{"type":"integer","description":"Código da situação atual do DF-e."},"motivo_status":{"type":"string","description":"Descrição literal da situação atual do DF-e."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora de processamento."},"chave":{"type":"string","description":"Chave de Acesso do DF-e consultado."}}},"NfseCidadesAtendidas":{"type":"object","properties":{"@count":{"type":"integer","description":"Quantidade de cidades atendidas pela API."},"data":{"type":"array","description":"Lista com os códigos IBGE das cidades atendidas pela API.","items":{"type":"string"}}}},"NfseCidadeMetadados":{"type":"object","properties":{"codigo_ibge":{"type":"string","description":"Código IBGE do município."},"uf":{"type":"string","description":"UF do município."},"municipio":{"type":"string","description":"Nome do município."},"provedor":{"type":"string","description":"Provedor do município."},"ambientes":{"type":"array","description":"Ambientes disponíveis no provedor.","items":{"type":"string","enum":["homologacao","producao"]}},"credenciais":{"type":"array","description":"Credenciais requeridas para autenticação no provedor.","items":{"type":"string","enum":["certificado","login_senha","token"]}}}},"RpsPedidoEmissaoLote":{"type":"object","properties":{"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"],"x-nullable":true},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50},"lista_rps":{"type":"array","items":{"$ref":"#/definitions/RpsPedidoEmissao"},"maxItems":50}},"required":["ambiente"]},"RpsPedidoEmissao":{"type":"object","properties":{"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento."},"data_emissao":{"type":"string","format":"date-time","description":"Data e Hora de Emissão do RPS, no formato AAAA-MM-DDTHH:MM:SSTZD.\r\nCaso não informado, será considerada a data/hora da requisição à API."},"competencia":{"type":"string","format":"date-time","description":"Competência do RPS, no formato AAAA-MM-DD.\r\nCaso não informado, será considerada a data da requisição à API."},"natureza_tributacao":{"type":"integer","description":"Natureza da tributação:\r\n* 1 - Simples Nacional;\r\n* 2 - Fixo;\r\n* 3 - Depósito em juízo;\r\n* 4 - Exigibilidade suspensa por decisão judicial;\r\n* 5 - Exigibilidade suspensa por procedimento administrativo;\r\n* 6 - Isenção parcial."},"prestador":{"$ref":"#/definitions/RpsIdentificacaoPrestador","description":"Dados da empresa emitente."},"tomador":{"$ref":"#/definitions/RpsDadosTomador","description":"Dados do tomador/destinatário."},"intermediario":{"$ref":"#/definitions/RpsDadosIntermediario","description":"Dados do íntermediário."},"construcao_civil":{"$ref":"#/definitions/RpsDadosConstrucaoCivil"},"servicos":{"type":"array","items":{"$ref":"#/definitions/RpsDadosServico"},"maxItems":1,"minItems":1},"outras_informacoes":{"type":"string","description":"Informações adicionais ao documento.","maxLength":255}},"required":["servicos","tomador","prestador"]},"RpsIdentificacaoPrestador":{"type":"object","properties":{"cpf_cnpj":{"type":"string","description":"CPF ou CNPJ do prestador.\r\nUtilize o valor sem máscara."}},"required":["cpf_cnpj"]},"RpsDadosTomador":{"type":"object","properties":{"cpf_cnpj":{"type":"string","description":"CPF ou CNPJ do tomador/destinatário."},"inscricao_municipal":{"type":"string","description":"Inscrição Municipal do tomador/destinatário."},"nome_razao_social":{"type":"string","description":"Nome ou Razão Social do tomador/destinatário."},"fone":{"type":"string","description":"Telefone do tomador/destinatário."},"email":{"type":"string","description":"Email do tomador/destinatário."},"endereco":{"$ref":"#/definitions/RpsDadosTomadorEndereco","description":"Endereço do tomador/destinatário."}},"required":["nome_razao_social"]},"RpsDadosTomadorEndereco":{"type":"object","properties":{"logradouro":{"type":"string","description":"Logradouro."},"numero":{"type":"string","description":"Número."},"complemento":{"type":"string","description":"Complemento.","maxLength":500},"bairro":{"type":"string","description":"Bairro."},"codigo_municipio":{"type":"string","description":"Código IBGE do município."},"cidade":{"type":"string","description":"Cidade.","maxLength":255},"uf":{"type":"string","description":"Sigla do estado."},"codigo_pais":{"type":"string","default":"1058"},"pais":{"type":"string","description":"Nome do país.","maxLength":255},"cep":{"type":"string","description":"CEP.\r\nUtilize o valor sem máscara."}}},"RpsDadosIntermediario":{"type":"object","properties":{"cpf_cnpj":{"type":"string"},"nome_razao_social":{"type":"string"},"inscricao_municipal":{"type":"string"}}},"RpsDadosConstrucaoCivil":{"type":"object","properties":{"codigo_obra":{"type":"string"},"art":{"type":"string"}}},"RpsDadosServico":{"type":"object","properties":{"iss_retido":{"type":"boolean","description":"Reter ISSQN.","default":false},"responsavel_retencao":{"type":"integer","description":"Responsável pela retenção:\r\n* 0 - Prestador;\r\n* 1 - Tomador;\r\n* 2 - Intermediário.","default":0},"item_lista_servico":{"type":"string","description":"Código do item da lista de serviço, geralmente segue a LC116, podendo variar de acordo com a prefeitura.\r\n\r\nVocê pode encontrar esse dado no portal da prefeitura, em uma nota emitida ou junto ao contador."},"codigo_cnae":{"type":"string","description":"Código CNAE (Classificação Nacional de Atividades Econômicas)."},"codigo_tributacao_municipio":{"type":"string","description":"Código de tributação do município."},"discriminacao":{"type":"string","description":"Detalhamento do serviço prestado."},"codigo_municipio":{"type":"string","description":"Código IBGE do município de prestação do serviço.\r\nCaso não informado, será considerado o município do prestador."},"codigo_pais":{"type":"string","description":"Código do país de prestação do serviço."},"tipo_tributacao":{"type":"integer","description":"Tipo de Tributação do Serviço:\r\n* 1 - Isento de ISS\r\n* 2 - Imune\r\n* 3 - Não Incidência no Município\r\n* 4 - Não Tributável\r\n* 5 - Retido\r\n* 6 - Tributável Dentro do Município\r\n* 7 - Tributável Fora do Município\r\n* 8 - Tributável Dentro do Município pelo tomador","default":6},"exigibilidade_iss":{"type":"integer","description":"Exigibilidade do ISS:\r\n* 1 - Exigível\r\n* 2 - Não Incidência\r\n* 3 - Isenção\r\n* 4 - Exportação\r\n* 5 - Imunidade\r\n* 6 - Suspenso por Decisão Judicial\r\n* 7 - Suspenso por Processo Administrativo","default":1},"codigo_municipio_incidencia":{"type":"string","description":"Código IBGE do município de incidência do ISSQN."},"numero_processo":{"type":"string","description":"Número do Processo de Suspensão da Exigibilidade."},"unidade":{"type":"string","description":"Unidade do serviço prestado."},"quantidade":{"type":"number","description":"Quantidade dos serviços prestados.","default":1,"minimum":0,"exclusiveMinimum":true},"valores":{"$ref":"#/definitions/RpsServicoValores"}},"required":["valores","discriminacao","item_lista_servico"]},"RpsServicoValores":{"type":"object","properties":{"valor_unitario":{"type":"number","description":"Valor unitário do serviço."},"valor_servicos":{"type":"number","description":"Valor total do serviço."},"valor_deducoes":{"type":"number"},"valor_pis":{"type":"number"},"valor_cofins":{"type":"number"},"valor_inss":{"type":"number"},"valor_ir":{"type":"number"},"valor_csll":{"type":"number"},"valor_outras_retencoes":{"type":"number"},"valor_iss":{"type":"number"},"valor_iss_retido":{"type":"number"},"valor_liquido":{"type":"number"},"aliquota_iss":{"type":"number"},"aliquota_pis":{"type":"number"},"aliquota_cofins":{"type":"number"},"aliquota_inss":{"type":"number"},"aliquota_ir":{"type":"number"},"aliquota_csll":{"type":"number"},"desconto_incondicionado":{"type":"number"},"desconto_condicionado":{"type":"number"}},"required":["valor_unitario"]},"RpsLote":{"type":"object","properties":{"id":{"type":"string","description":"ID único do lote gerado automaticamente pela API."},"created_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["novo","fila_envio","fila_consulta","processado","erro"]},"numero":{"type":"string"},"ambiente":{"type":"string","enum":["homologacao","producao"]},"referencia":{"type":"string"},"notas":{"type":"array","items":{"$ref":"#/definitions/Nfse"}}}},"Nfse":{"type":"object","properties":{"id":{"type":"string","description":"ID único da nota gerado automaticamente pela API."},"created_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["processando","autorizada","negada","cancelada","substituida","erro"]},"numero":{"type":"string"},"codigo_verificacao":{"type":"string"},"link_url":{"type":"string"},"data_emissao":{"type":"string","format":"date-time","x-nullable":true},"ambiente":{"type":"string","enum":["homologacao","producao"]},"referencia":{"type":"string"},"DPS":{"$ref":"#/definitions/DPS"},"cancelamento":{"$ref":"#/definitions/NfseCancelamento"},"mensagens":{"type":"array","items":{"$ref":"#/definitions/NfseMensagemRetorno"}},"declaracao_prestacao_servico":{"$ref":"#/definitions/Rps"}}},"DPS":{"type":"object","description":"Grupo de informações da DPS relativas ao serviço prestado.","properties":{"serie":{"type":"string","description":"Série do DPS.","x-nullable":true},"nDPS":{"type":"string","description":"Número do DPS.","x-nullable":true}}},"NfseCancelamento":{"type":"object","properties":{"id":{"type":"string","description":"ID único do cancelamento gerado automaticamente pela API."},"status":{"type":"string","enum":["pendente","concluido","rejeitado","erro"]},"codigo":{"type":"string"},"motivo":{"type":"string"},"data_hora":{"type":"string","format":"date-time","x-nullable":true},"mensagens":{"type":"array","items":{"$ref":"#/definitions/NfseMensagemRetorno"}}}},"NfseMensagemRetorno":{"type":"object","properties":{"codigo":{"type":"string"},"descricao":{"type":"string"},"correcao":{"type":"string"}}},"Rps":{"type":"object","description":"*Propriedade obsoleta. Não é mais retornada pela API.*","properties":{"rps":{"$ref":"#/definitions/RpsDados"},"competencia":{"type":"string","format":"date-time"},"natureza_tributacao":{"type":"integer","description":"Natureza da tributação\r\n1 - Simples Nacional;\r\n2 - Fixo;\r\n3 - Depósito em juízo;\r\n4 - Exigibilidade suspensa por decisão judicial;\r\n5 - Exigibilidade suspensa por procedimento administrativo;\r\n6 - Isenção parcial."},"prestador":{"$ref":"#/definitions/RpsDadosPrestador"},"tomador":{"$ref":"#/definitions/RpsDadosTomador"},"intermediario":{"$ref":"#/definitions/RpsDadosIntermediario"},"construcao_civil":{"$ref":"#/definitions/RpsDadosConstrucaoCivil"},"servicos":{"type":"array","items":{"$ref":"#/definitions/RpsDadosServico"},"minItems":1},"outras_informacoes":{"type":"string","description":"Informações adicionais ao documento."}},"required":["servicos"]},"RpsDados":{"type":"object","properties":{"identificacao_rps":{"$ref":"#/definitions/RpsIdentificacao"},"data_emissao":{"type":"string","format":"date-time"}}},"RpsIdentificacao":{"type":"object","properties":{"numero":{"type":"string"},"serie":{"type":"string"},"tipo":{"type":"string"}}},"RpsDadosPrestador":{"type":"object","properties":{"cpf_cnpj":{"type":"string"},"inscricao_municipal":{"type":"string"},"nome_razao_social":{"type":"string"},"nome_fantasia":{"type":"string"},"fone":{"type":"string"},"email":{"type":"string"},"endereco":{"$ref":"#/definitions/EmpresaEndereco"},"optante_simples_nacional":{"type":"boolean"},"regime_tributacao":{"type":"integer"},"regime_especial_tributacao":{"type":"integer"},"incentivo_fiscal":{"type":"boolean"},"incentivador_cultural":{"type":"boolean"}}},"NfseLoteDpsPedidoEmissao":{"type":"object","properties":{"provedor":{"type":"string","description":"Default: `\"padrao\"`\r\n\r\nIdentificação do provedor para transmissão da DPS:\r\n * `\"padrao\"`: Provedor padrão da prefeitura.\r\n * `\"nacional\"`: Ambiente de Dados Nacional (ADN) do <a href=\"https://www.gov.br/nfse/pt-br\" target=\"blank\">Sistema Nacional NFS-e</a>.","enum":["padrao","nacional"]},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"],"x-nullable":true},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50},"documentos":{"type":"array","description":"Lista com as informações das DPS relativas aos serviços prestados.","items":{"$ref":"#/definitions/NfseDpsPedidoEmissao"},"maxItems":50}},"required":["ambiente"]},"NfseDpsPedidoEmissao":{"type":"object","properties":{"provedor":{"type":"string","description":"Default: `\"padrao\"`\r\n\r\nIdentificação do provedor para transmissão da DPS:\r\n * `\"padrao\"`: Provedor padrão da prefeitura.\r\n * `\"nacional\"`: Ambiente de Dados Nacional (ADN) do <a href=\"https://www.gov.br/nfse/pt-br\" target=\"blank\">Sistema Nacional NFS-e</a>.","enum":["padrao","nacional"]},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true},"infDPS":{"$ref":"#/definitions/InfDPS"}},"required":["infDPS","ambiente"]},"InfDPS":{"type":"object","description":"Grupo de informações da DPS relativas ao serviço prestado.","properties":{"tpAmb":{"type":"integer","description":"Identificação do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e hora da emissão do DPS. Data e hora no formato UTC (Universal Coordinated Time): AAAA-MM-DDThh:mm:ssTZD.","x-nullable":true},"verAplic":{"type":"string","description":"Versão do aplicativo que gerou o DPS.","maxLength":20,"minLength":1,"x-nullable":true},"dCompet":{"type":"string","format":"date","description":"Data em que se iniciou a prestação do serviço: Dia, mês e ano (AAAAMMDD). (AAAA-MM-DDThh:mm:ssTZD).\r\n\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"cMotivoEmisTI":{"type":"integer","description":"Motivo da Emissão da DPS pelo Tomador/Intermediário:\r\n* 1 - Importação de Serviço\r\n* 2 - Tomador/Intermediário obrigado a emitir NFS-e por legislação municipal\r\n* 3 - Tomador/Intermediário emitindo NFS-e por recusa de emissão pelo prestador\r\n* 4 - Tomador/Intermediário emitindo por rejeitar a NFS-e emitida pelo prestador","x-nullable":true},"chNFSeRej":{"type":"string","description":"Chave de Acesso da NFS-e rejeitada pelo Tomador/Intermediário.","maxLength":50,"x-nullable":true},"subst":{"$ref":"#/definitions/Substituicao"},"prest":{"$ref":"#/definitions/InfoPrestador"},"toma":{"$ref":"#/definitions/InfoTomador"},"interm":{"$ref":"#/definitions/InfoIntermediario"},"serv":{"$ref":"#/definitions/Serv"},"valores":{"$ref":"#/definitions/InfoValores"},"IBSCBS":{"$ref":"#/definitions/RTCInfoIBSCBS"}},"required":["valores","serv","prest","dhEmi"]},"Substituicao":{"type":"object","description":"Dados da NFS-e a ser substituída.","properties":{"chSubstda":{"type":"string","description":"Chave de acesso da NFS-e a ser substituída.","maxLength":50,"x-nullable":true},"cMotivo":{"type":"string","description":"Código de justificativa para substituição de NFS-e:\r\n* 01 - Desenquadramento de NFS-e do Simples Nacional\r\n* 02 - Enquadramento de NFS-e no Simples Nacional\r\n* 03 - Inclusão Retroativa de Imunidade/Isenção para NFS-e\r\n* 04 - Exclusão Retroativa de Imunidade/Isenção para NFS-e\r\n* 05 - Rejeição de NFS-e pelo tomador ou pelo intermediário se responsável pelo recolhimento do tributo\r\n* 99 - Outros","x-nullable":true},"xMotivo":{"type":"string","description":"Descrição do motivo da substituição da NFS-e.","maxLength":255,"minLength":15,"x-nullable":true}},"required":["cMotivo","chSubstda"]},"InfoPrestador":{"type":"object","description":"Grupo de informações do DPS relativas ao Prestador de Serviços.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nObrigatório caso o emitente seja pessoa jurídica.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nObrigatorio caso o emitente seja pessoa física.","maxLength":11,"x-nullable":true},"regTrib":{"$ref":"#/definitions/RegTrib"}}},"RegTrib":{"type":"object","description":"Grupo de informações relativas aos regimes de tributação do prestador de serviços.","properties":{"regEspTrib":{"type":"integer","description":"Regime Especial de Tributação da Prefeitura.\r\n\r\nCampo opcional utilizado no momento da emissão da NFS-e para informar\r\ndiretamente o código de regime especial de tributação esperado pela\r\nprefeitura.\r\n\r\n**Comportamento:**\r\n- Ao preencher este campo, o valor será inserido diretamente no XML\r\n  da NFS-e, sem qualquer conversão pela API.\r\n- Esse campo sobrescreve o valor configurado previamente nas\r\n  configurações de NFS-e da empresa.\r\n- É especialmente útil quando a prefeitura utiliza códigos próprios que\r\n  não existem no padrão nacional (como valores diferentes dos listados\r\n  de 0 a 6).\r\n\r\n**Cenários de uso:**\r\n- Quando a prefeitura exige um código que não pode ser representado\r\n  pelos valores do padrão nacional.\r\n- Quando houver necessidade de enviar o código exato esperado pela\r\n  prefeitura, sem depender da lógica de conversão automática da API.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true}}},"InfoTomador":{"type":"object","description":"Grupo de informações do DPS relativas ao Tomador de Serviços.","properties":{"orgaoPublico":{"type":"boolean","description":"Indica se o tomador do serviço é um orgão público.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","default":false,"x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.","maxLength":11,"x-nullable":true},"NIF":{"type":"string","description":"Número de Identificação Fiscal fornecido por órgão de administração tributária no exterior.","maxLength":40,"minLength":1,"x-nullable":true},"cNaoNIF":{"type":"integer","description":"Motivo para não informação do NIF:\r\n* 0 - Não informado na nota de origem\r\n* 1 - Dispensado do NIF\r\n* 2 - Não exigência do NIF","x-nullable":true},"CAEPF":{"type":"string","description":"Número do Cadastro de Atividade Econômica da Pessoa Física (CAEPF) do tomador, intermediário ou fornecedor do serviço.","maxLength":14,"x-nullable":true},"IM":{"type":"string","description":"Número da inscrição municipal.","maxLength":15,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Número da inscrição estadual.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"xNome":{"type":"string","description":"Nome/Nome Empresarial.","maxLength":300,"minLength":1,"x-nullable":true},"end":{"$ref":"#/definitions/Endereco"},"fone":{"type":"string","description":"Número do telefone do prestador:\r\nPreencher com o Código DDD + número do telefone.\r\nNas operações com exterior é permitido informar o código do país + código da localidade + número do telefone).","x-nullable":true},"email":{"type":"string","description":"* E-mail","maxLength":80,"minLength":1,"x-nullable":true}},"required":["xNome"]},"Endereco":{"type":"object","description":"Dados de endereço do prestador.","properties":{"endNac":{"$ref":"#/definitions/EnderNac"},"endExt":{"$ref":"#/definitions/EnderExt"},"xLgr":{"type":"string","description":"Tipo e nome do logradouro da localização do imóvel.","maxLength":255,"minLength":1,"x-nullable":true},"tpLgr":{"type":"string","description":"Tipo do Logradouro.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"nro":{"type":"string","description":"Número do imóvel.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento do endereço.","maxLength":156,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":1,"x-nullable":true}}},"EnderNac":{"type":"object","description":"Grupo de informações específicas de endereço nacional.","properties":{"cMun":{"type":"string","description":"Código do município, conforme Tabela do IBGE.","x-nullable":true},"CEP":{"type":"string","description":"Número do CEP.","x-nullable":true}}},"EnderExt":{"type":"object","description":"Grupo de informações específicas de endereço no exterior.","properties":{"cPais":{"type":"string","description":"Código do país (Tabela de Países ISO).","x-nullable":true},"cEndPost":{"type":"string","description":"Código alfanumérico do Endereçamento Postal no exterior do prestador do serviço.","maxLength":11,"minLength":1,"x-nullable":true},"xCidade":{"type":"string","description":"Nome da cidade no exterior do prestador do serviço.","maxLength":60,"minLength":1,"x-nullable":true},"xEstProvReg":{"type":"string","description":"Estado, província ou região da cidade no exterior do prestador do serviço.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xEstProvReg","xCidade","cEndPost","cPais"]},"InfoIntermediario":{"type":"object","description":"Grupo de informações do DPS relativas ao Intermediário de Serviços.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.","maxLength":11,"x-nullable":true},"NIF":{"type":"string","description":"Número de Identificação Fiscal fornecido por órgão de administração tributária no exterior.","maxLength":40,"minLength":1,"x-nullable":true},"cNaoNIF":{"type":"integer","description":"Motivo para não informação do NIF:\r\n* 0 - Não informado na nota de origem\r\n* 1 - Dispensado do NIF\r\n* 2 - Não exigência do NIF","x-nullable":true},"CAEPF":{"type":"string","description":"Número do Cadastro de Atividade Econômica da Pessoa Física (CAEPF) do tomador, intermediário ou fornecedor do serviço.","maxLength":14,"x-nullable":true},"IM":{"type":"string","description":"Número da inscrição municipal.","maxLength":15,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Número da inscrição estadual.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"xNome":{"type":"string","description":"Nome/Nome Empresarial.","maxLength":300,"minLength":1,"x-nullable":true},"end":{"$ref":"#/definitions/Endereco"},"fone":{"type":"string","description":"Número do telefone do prestador:\r\nPreencher com o Código DDD + número do telefone.\r\nNas operações com exterior é permitido informar o código do país + código da localidade + número do telefone).","x-nullable":true},"email":{"type":"string","description":"* E-mail","maxLength":80,"minLength":1,"x-nullable":true}},"required":["xNome"]},"Serv":{"type":"object","description":"Grupo de informações do DPS relativas ao Serviço Prestado.","properties":{"locPrest":{"$ref":"#/definitions/LocPrest"},"cServ":{"$ref":"#/definitions/CServ"},"comExt":{"$ref":"#/definitions/ComExterior"},"lsadppu":{"$ref":"#/definitions/LocacaoSublocacao"},"obra":{"$ref":"#/definitions/InfoObra"},"atvEvento":{"$ref":"#/definitions/AtvEvento"},"explRod":{"$ref":"#/definitions/ExploracaoRodoviaria"},"infoCompl":{"$ref":"#/definitions/InfoCompl"}},"required":["cServ"]},"LocPrest":{"type":"object","description":"Grupo de informações relativas ao local da prestação do serviço.","properties":{"cLocPrestacao":{"type":"string","description":"Código do município onde o serviço foi prestado (tabela do IBGE).\r\n\r\nCaso não seja informado, será considerado o município do Prestador do serviço.","x-nullable":true},"cPaisPrestacao":{"type":"string","description":"Código do país onde o serviço foi prestado (Tabela de Países ISO).","x-nullable":true}}},"CServ":{"type":"object","description":"Grupo de informações relativas ao código do serviço prestado.","properties":{"cTribNac":{"type":"string","description":"Código de tributação nacional do ISSQN.\r\n**Ambiente Nacional**: O código deve conter exatamente 6 dígitos numéricos, sendo 2 para Item (LC 116/2003), 2 para Subitem (LC 116/2003) e 2 para Desdobro Nacional. Exemplo: `010701`.\r\n**Envio direto para a Prefeitura**: Em muitos municípios, continua sendo exigido apenas o código conforme a LC 116/2003, totalizando 4 dígitos numéricos (2 para Item e 2 para Subitem). Exemplo: `0107`.","x-nullable":true},"cTribMun":{"type":"string","description":"Código de tributação municipal do ISSQN.","x-nullable":true},"CNAE":{"type":"string","description":"Código CNAE (Classificação Nacional de Atividades Econômicas).","x-nullable":true},"xDescServ":{"type":"string","description":"Descrição completa do serviço prestado.\r\n\r\nOs caracteres acentuados poderão ser alterados para caracteres sem acentuação.","maxLength":2000,"minLength":1,"x-nullable":true},"cNBS":{"type":"string","description":"Código NBS correspondente ao serviço prestado, seguindo a versão 2.0, conforme Anexo B.","x-nullable":true},"cNatOp":{"type":"string","description":"Código de natureza da operação.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"cSitTrib":{"type":"string","description":"Código de situação tributária.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true}},"required":["xDescServ","cTribNac"]},"ComExterior":{"type":"object","description":"Grupo de informações relativas à exportação/importação de serviço prestado.","properties":{"mdPrestacao":{"type":"integer","description":"Modo de Prestação:\r\n* 0 - Desconhecido (tipo não informado na nota de origem)\r\n* 1 - Transfronteiriço\r\n* 2 - Consumo no Brasil\r\n* 3 - Movimento Temporário de Pessoas Físicas\r\n* 4 - Consumo no Exterior","x-nullable":true},"vincPrest":{"type":"integer","description":"Vínculo entre as partes no negócio:\r\n* 0 - Sem vínculo com o Tomador/Prestador\r\n* 1 - Controlada\r\n* 2 - Controladora\r\n* 3 - Coligada\r\n* 4 - Matriz\r\n* 5 - Filial ou sucursal\r\n* 6 - Outro vínculo","x-nullable":true},"tpMoeda":{"type":"string","description":"Identifica a moeda da transação comercial.","maxLength":3,"x-nullable":true},"vServMoeda":{"type":"number","description":"Valor do serviço prestado expresso em moeda estrangeira especificada em tpmoeda.","minimum":0,"x-nullable":true},"mecAFComexP":{"type":"string","description":"Mecanismo de apoio/fomento ao Comércio Exterior utilizado pelo prestador do serviço:\r\n* 00 - Desconhecido (tipo não informado na nota de origem)\r\n* 01 - Nenhum\r\n* 02 - ACC - Adiantamento sobre Contrato de Câmbio - Redução a Zero do IR e do IOF\r\n* 03 - ACE - Adiantamento sobre Cambiais Entregues - Redução a Zero do IR e do IOF\r\n* 04 - BNDES-Exim Pós-Embarque - Serviços\r\n* 05 - BNDES-Exim Pré-Embarque - Serviços\r\n* 06 - FGE - Fundo de Garantia à Exportação\r\n* 07 - PROEX - EQUALIZAÇÃO\r\n* 08 - PROEX - Financiamento","x-nullable":true},"mecAFComexT":{"type":"string","description":"Mecanismo de apoio/fomento ao Comércio Exterior utilizado pelo tomador do serviço:\r\n* 00 - Desconhecido (tipo não informado na nota de origem)\r\n* 01 - Nenhum\r\n* 02 - Adm. Pública e Repr. Internacional\r\n* 03 - Alugueis e Arrend. Mercantil de maquinas, equip., embarc. e aeronaves\r\n* 04 - Arrendamento Mercantil de aeronave para empresa de transporte aéreo público\r\n* 05 - Comissão a agentes externos na exportação\r\n* 06 - Despesas de armazenagem, mov. e transporte de carga no exterior\r\n* 07 - Eventos FIFA (subsidiária)\r\n* 08 - Eventos FIFA\r\n* 09 - Fretes, arrendamentos de embarcações ou aeronaves e outros\r\n* 10 - Material Aeronáutico\r\n* 11 - Promoção de Bens no Exterior\r\n* 12 - Promoção de Dest. Turísticos Brasileiros\r\n* 13 - Promoção do Brasil no Exterior\r\n* 14 - Promoção Serviços no Exterior\r\n* 15 - RECINE\r\n* 16 - RECOPA\r\n* 17 - Registro e Manutenção de marcas, patentes e cultivares\r\n* 18 - REICOMP\r\n* 19 - REIDI\r\n* 20 - REPENEC\r\n* 21 - REPES\r\n* 22 - RETAERO\r\n* 23 - RETID\r\n* 24 - Royalties, Assistência Técnica, Científica e Assemelhados\r\n* 25 - Serviços de avaliação da conformidade vinculados aos Acordos da OMC\r\n* 26 - ZPE","x-nullable":true},"movTempBens":{"type":"integer","description":"Vínculo da Operação à Movimentação Temporária de Bens:\r\n* 0 - Desconhecido (tipo não informado na nota de origem)\r\n* 1 - Não\r\n* 2 - Vinculada - Declaração de Importação\r\n* 3 - Vinculada - Declaração de Exportação","x-nullable":true},"nDI":{"type":"string","description":"Número da Declaração de Importação (DI/DSI/DA/DRI-E) averbado.","maxLength":12,"minLength":1,"x-nullable":true},"nRE":{"type":"string","description":"Número do Registro de Exportação (RE) averbado.","maxLength":12,"minLength":1,"x-nullable":true},"mdic":{"type":"integer","description":"Compartilhar as informações da NFS-e gerada a partir desta DPS com a Secretaria de Comércio Exterior:\r\n* 0 - Não enviar para o MDIC\r\n* 1 - Enviar para o MDIC","x-nullable":true}},"required":["mdic","movTempBens","mecAFComexT","mecAFComexP","vServMoeda","tpMoeda","vincPrest","mdPrestacao"]},"LocacaoSublocacao":{"type":"object","description":"Grupo de informações relativas a atividades de Locação, sublocação, arrendamento, direito de passagem ou permissão de uso, compartilhado ou não, de ferrovia, rodovia, postes, cabos, dutos e condutos de qualquer natureza.","properties":{"categ":{"type":"integer","description":"Categoria do serviço.","x-nullable":true},"objeto":{"type":"integer","description":"Tipo de objetos da locação, sublocação, arrendamento, direito de passagem ou permissão de uso.","x-nullable":true},"extensao":{"type":"string","description":"Extensão total da ferrovia, rodovia, cabos, dutos ou condutos.","maxLength":5,"minLength":1,"x-nullable":true},"nPostes":{"type":"string","description":"Número total de postes.","maxLength":6,"minLength":1,"x-nullable":true}},"required":["nPostes","extensao","objeto","categ"]},"InfoObra":{"type":"object","description":"Grupo de informações do DPS relativas à serviço de obra.","properties":{"inscImobFisc":{"type":"string","description":"Inscrição imobiliária fiscal (código fornecido pela Prefeitura Municipal para a identificação da obra ou para fins de recolhimento do IPTU).","maxLength":30,"minLength":1,"x-nullable":true},"cObra":{"type":"string","description":"Número de identificação da obra.\r\nCadastro Nacional de Obras (CNO) ou Cadastro Específico do INSS (CEI).","maxLength":30,"minLength":1,"x-nullable":true},"cCIB":{"type":"string","description":"Código do Cadastro Imobiliário Brasileiro - CIB.","maxLength":8,"x-nullable":true},"end":{"$ref":"#/definitions/EnderObraEvento"}}},"EnderObraEvento":{"type":"object","description":"Grupo de informações do endereço da obra do serviço prestado.","properties":{"CEP":{"type":"string","description":"Número do CEP.","x-nullable":true},"endExt":{"$ref":"#/definitions/EnderExtSimples"},"xLgr":{"type":"string","description":"Tipo e nome do logradouro da localização do imóvel.","maxLength":255,"minLength":1,"x-nullable":true},"tpLgr":{"type":"string","description":"Tipo do Logradouro.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"nro":{"type":"string","description":"Número do imóvel.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento do endereço.","maxLength":156,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xBairro","nro","xLgr"]},"EnderExtSimples":{"type":"object","description":"Grupo de informações específicas de endereço no exterior.","properties":{"cEndPost":{"type":"string","description":"Código alfanumérico do Endereçamento Postal no exterior do prestador do serviço.","maxLength":11,"minLength":1,"x-nullable":true},"xCidade":{"type":"string","description":"Nome da cidade no exterior do prestador do serviço.","maxLength":60,"minLength":1,"x-nullable":true},"xEstProvReg":{"type":"string","description":"Estado, província ou região da cidade no exterior do prestador do serviço.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xEstProvReg","xCidade","cEndPost"]},"AtvEvento":{"type":"object","description":"Grupo de informações do DPS relativas à Evento.","properties":{"xNome":{"type":"string","description":"Descrição do evento Artístico, Cultural, Esportivo, etc.","maxLength":255,"minLength":1,"x-nullable":true},"desc":{"type":"string","description":"`Deprecated`\r\n\r\n**Propriedade depreciada**.\r\n\r\n*Utilize `xNome`*.","maxLength":255,"minLength":1,"x-nullable":true},"dtIni":{"type":"string","format":"date","description":"Data de início da atividade de evento. Ano, Mês e Dia (AAAA-MM-DD).","x-nullable":true},"dtFim":{"type":"string","format":"date","description":"Data de fim da atividade de evento. Ano, Mês e Dia (AAAA-MM-DD).","x-nullable":true},"idAtvEvt":{"type":"string","description":"Identificação da Atividade de Evento (código identificador de evento determinado pela Administração Tributária Municipal).","maxLength":30,"minLength":1,"x-nullable":true},"id":{"type":"string","description":"`Deprecated`\r\n\r\n**Propriedade depreciada**.\r\n\r\n*Utilize `idAtvEvt`*.","maxLength":30,"minLength":1,"x-nullable":true},"end":{"$ref":"#/definitions/EnderecoSimples"}},"required":["dtFim","dtIni"]},"EnderecoSimples":{"type":"object","description":"Grupo de informações relativas ao endereço da atividade, evento ou local do serviço prestado.","properties":{"CEP":{"type":"string","description":"Número do CEP.","x-nullable":true},"endExt":{"$ref":"#/definitions/EnderExtSimples"},"xLgr":{"type":"string","description":"Tipo e nome do logradouro da localização do imóvel.","maxLength":255,"minLength":1,"x-nullable":true},"tpLgr":{"type":"string","description":"Tipo do Logradouro.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"nro":{"type":"string","description":"Número do imóvel.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento do endereço.","maxLength":156,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xBairro","nro","xLgr"]},"ExploracaoRodoviaria":{"type":"object","description":"Grupo de informações relativas a pedágio.","properties":{"categVeic":{"type":"string","description":"Categorias de veículos para cobrança:\r\n* 00 - Categoria de veículos (tipo não informado na nota de origem)\r\n* 01 - Automóvel, caminhonete e furgão\r\n* 02 - Caminhão leve, ônibus, caminhão trator e furgão\r\n* 03 - Automóvel e caminhonete com semireboque\r\n* 04 - Caminhão, caminhão-trator, caminhão-trator com semi-reboque e ônibus\r\n* 05 - Automóvel e caminhonete com reboque\r\n* 06 - Caminhão com reboque\r\n* 07 - Caminhão trator com semi-reboque\r\n* 08 - Motocicletas, motonetas e bicicletas motorizadas\r\n* 09 - Veículo especial\r\n* 10 - Veículo Isento","x-nullable":true},"nEixos":{"type":"string","description":"Número de eixos para fins de cobrança.","x-nullable":true},"rodagem":{"type":"integer","description":"Tipo de rodagem.","x-nullable":true},"sentido":{"type":"string","description":"Placa do veículo.","x-nullable":true},"placa":{"type":"string","description":"Placa do veículo.","x-nullable":true},"codAcessoPed":{"type":"string","description":"Código de acesso gerado automaticamente pelo sistema emissor da concessionária.","x-nullable":true},"codContrato":{"type":"string","description":"Código de contrato gerado automaticamente pelo sistema nacional no cadastro da concessionária.","x-nullable":true}},"required":["codContrato","codAcessoPed","placa","sentido","rodagem","nEixos","categVeic"]},"InfoCompl":{"type":"object","description":"Grupo de informações complementares disponível para todos os serviços prestados.","properties":{"idDocTec":{"type":"string","description":"Identificador de Documento de Responsabilidade Técnica: ART, RRT, DRT, Outros.","maxLength":40,"minLength":1,"x-nullable":true},"docRef":{"type":"string","description":"Chave da nota, número identificador da nota, número do contrato ou outro identificador de documento emitido pelo prestador de serviços, que subsidia a emissão dessa nota pelo tomador do serviço ou intermediário (preenchimento obrigatório caso a nota esteja sendo emitida pelo Tomador ou intermediário do serviço).","maxLength":255,"minLength":1,"x-nullable":true},"xPed":{"type":"string","description":"Número do  pedido/ordem de compra/ordem de serviço/projeto que autorize a prestação do serviço em operações B2B - Informação de interesse do tomador do serviço para controle e gestão da Negociação.","maxLength":60,"minLength":1,"x-nullable":true},"gItemPed":{"$ref":"#/definitions/InfoItemPed"},"xInfComp":{"type":"string","description":"Informações complementares.","maxLength":2000,"minLength":1,"x-nullable":true}}},"InfoItemPed":{"type":"object","description":"Grupo de itens do pedido/ordem de compra/ordem de serviço/projeto.","properties":{"xItemPed":{"type":"array","description":"Número do item do  pedido/ordem de compra/ordem de serviço/projeto - Identificação do número do item do pedido ou ordem de compra destacado e xPed.","items":{"type":"string"},"maxItems":99,"minItems":1}},"required":["xItemPed"]},"InfoValores":{"type":"object","description":"Grupo de informações relativas à valores do serviço prestado.","properties":{"vServPrest":{"$ref":"#/definitions/VServPrest"},"vDescCondIncond":{"$ref":"#/definitions/VDescCondIncond"},"vDedRed":{"$ref":"#/definitions/InfoDedRed"},"trib":{"$ref":"#/definitions/InfoTributacao"}},"required":["trib","vServPrest"]},"VServPrest":{"type":"object","description":"Grupo de informações relativas aos valores do serviço prestado.","properties":{"vReceb":{"type":"number","description":"Valor monetário recebido pelo intermediário do serviço (R$).","minimum":0,"x-nullable":true},"vServ":{"type":"number","description":"Valor dos serviços em R$.","minimum":0,"x-nullable":true}},"required":["vServ"]},"VDescCondIncond":{"type":"object","description":"Grupo de informações relativas aos descontos condicionados e incondicionados.","properties":{"vDescIncond":{"type":"number","description":"Valor monetário do desconto incondicionado (R$).","minimum":0,"x-nullable":true},"vDescCond":{"type":"number","description":"Valor monetário do desconto condicionado (R$).","minimum":0,"x-nullable":true}}},"InfoDedRed":{"type":"object","description":"Grupo de informações relativas ao valores para dedução/redução do valor da base de cálculo (valor do serviço).","properties":{"pDR":{"type":"number","description":"Valor percentual padrão para dedução/redução do valor do serviço.","minimum":0,"x-nullable":true},"vDR":{"type":"number","description":"Valor monetário padrão para dedução/redução do valor do serviço.","minimum":0,"x-nullable":true},"documentos":{"$ref":"#/definitions/ListaDocDedRed"}}},"ListaDocDedRed":{"type":"object","description":"Grupo de informações de documento utilizado para Dedução/Redução do valor do serviço.","properties":{"docDedRed":{"type":"array","items":{"$ref":"#/definitions/DocDedRed"},"maxItems":1000,"minItems":1}},"required":["docDedRed"]},"DocDedRed":{"type":"object","description":"Grupo de informações de documento utilizado para Dedução/Redução do valor do serviço.","properties":{"chNFSe":{"type":"string","description":"Chave de Acesso da NFS-e (Padrão Nacional).","maxLength":50,"x-nullable":true},"chNFe":{"type":"string","description":"Chave de Acesso da NF-e.","maxLength":44,"x-nullable":true},"NFSeMun":{"$ref":"#/definitions/DocOutNFSe"},"NFNFS":{"$ref":"#/definitions/DocNFNFS"},"nDocFisc":{"type":"string","description":"Número de documento fiscal.","maxLength":255,"minLength":1,"x-nullable":true},"nDoc":{"type":"string","description":"Número de documento não fiscal.","maxLength":255,"minLength":1,"x-nullable":true},"tpDedRed":{"type":"integer","description":"Identificação da Dedução/Redução:\r\n* 1 - Alimentação e bebidas/frigobar\r\n* 2 - Materiais\r\n* 5 - Repasse consorciado\r\n* 6 - Repasse plano de saúde\r\n* 7 - Serviços\r\n* 8 - Subempreitada de mão de obra\r\n* 99 - Outras deduções","x-nullable":true},"xDescOutDed":{"type":"string","description":"Descrição da Dedução/Redução quando a opção é \"99 - Outras Deduções\".","maxLength":150,"minLength":1,"x-nullable":true},"dtEmiDoc":{"type":"string","format":"date","description":"Data da emissão do documento dedutível. Ano, mês e dia (AAAA-MM-DD).","x-nullable":true},"vDedutivelRedutivel":{"type":"number","description":"Valor monetário total dedutível/redutível no documento informado (R$).\r\nEste é o valor total no documento informado que é passível de dedução/redução.","minimum":0,"x-nullable":true},"vDeducaoReducao":{"type":"number","description":"Valor monetário utilizado para dedução/redução do valor do serviço da NFS-e que está sendo emitida (R$).\r\nDeve ser menor ou igual ao valor deduzível/redutível (vDedutivelRedutivel).","minimum":0,"x-nullable":true},"fornec":{"$ref":"#/definitions/InfoFornecDocDedRed"}},"required":["vDeducaoReducao","vDedutivelRedutivel","dtEmiDoc","tpDedRed"]},"DocOutNFSe":{"type":"object","description":"Grupo de informações de Outras NFS-e (Padrão anterior de NFS-e).","properties":{"cMunNFSeMun":{"type":"string","description":"Código Município emissor da nota eletrônica municipal (Tabela do IBGE).","x-nullable":true},"nNFSeMun":{"type":"integer","format":"int64","description":"Número da nota eletrônica municipal.","x-nullable":true},"cVerifNFSeMun":{"type":"string","description":"Código de Verificação da nota eletrônica municipal.","maxLength":9,"minLength":1,"x-nullable":true}},"required":["cVerifNFSeMun","nNFSeMun","cMunNFSeMun"]},"DocNFNFS":{"type":"object","description":"Grupo de informações de NF ou NFS (Modelo não eletrônico).","properties":{"nNFS":{"type":"integer","description":"Número da Nota Fiscal NF ou NFS.","maximum":9999999,"minimum":0,"x-nullable":true},"modNFS":{"type":"integer","format":"int64","description":"Modelo da Nota Fiscal NF ou NFS.","x-nullable":true},"serieNFS":{"type":"string","description":"Série Nota Fiscal NF ou NFS.","maxLength":15,"minLength":1,"x-nullable":true}},"required":["serieNFS","modNFS","nNFS"]},"InfoFornecDocDedRed":{"type":"object","description":"Grupo de informações do Fornecedor em Deduções de Serviços.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.","maxLength":11,"x-nullable":true},"NIF":{"type":"string","description":"Número de Identificação Fiscal fornecido por órgão de administração tributária no exterior.","maxLength":40,"minLength":1,"x-nullable":true},"cNaoNIF":{"type":"integer","description":"Motivo para não informação do NIF:\r\n* 0 - Não informado na nota de origem\r\n* 1 - Dispensado do NIF\r\n* 2 - Não exigência do NIF","x-nullable":true},"CAEPF":{"type":"string","description":"Número do Cadastro de Atividade Econômica da Pessoa Física (CAEPF) do tomador, intermediário ou fornecedor do serviço.","maxLength":14,"x-nullable":true},"IM":{"type":"string","description":"Número da inscrição municipal.","maxLength":15,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Número da inscrição estadual.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"xNome":{"type":"string","description":"Nome/Nome Empresarial.","maxLength":300,"minLength":1,"x-nullable":true},"end":{"$ref":"#/definitions/Endereco"},"fone":{"type":"string","description":"Número do telefone do prestador:\r\nPreencher com o Código DDD + número do telefone.\r\nNas operações com exterior é permitido informar o código do país + código da localidade + número do telefone).","x-nullable":true},"email":{"type":"string","description":"* E-mail","maxLength":80,"minLength":1,"x-nullable":true}},"required":["xNome"]},"InfoTributacao":{"type":"object","description":"Grupo de informações relacionados aos tributos relacionados ao serviço prestado.","properties":{"tribMun":{"$ref":"#/definitions/TribMunicipal"},"tribFed":{"$ref":"#/definitions/TribFederal"},"totTrib":{"$ref":"#/definitions/TribTotal"}},"required":["tribMun"]},"TribMunicipal":{"type":"object","description":"Grupo de informações relacionados ao Imposto Sobre Serviços de Qualquer Natureza - ISSQN.","properties":{"tribISSQN":{"type":"integer","description":"Tributação do ISSQN sobre o serviço prestado:\r\n* 1 - Operação tributável\r\n* 2 - Imunidade\r\n* 3 - Exportação de serviço\r\n* 4 - Não Incidência","x-nullable":true},"cPaisResult":{"type":"string","description":"Código do país onde se verficou o resultado da prestação do serviço para o caso de Exportação de Serviço.(Tabela de Países ISO).","x-nullable":true},"tpImunidade":{"type":"integer","description":"Identificação da Imunidade do ISSQN - somente para o caso de Imunidade.\r\nTipos de Imunidades:\r\n* 0 - Imunidade (tipo não informado na nota de origem)\r\n* 1 - Patrimônio, renda ou serviços, uns dos outros (CF88, Art 150, VI, a)\r\n* 2 - Templos de qualquer culto (CF88, Art 150, VI, b)\r\n* 3 - Patrimônio, renda ou serviços dos partidos políticos, inclusive suas fundações, das entidades sindicais dos trabalhadores, das instituições de educação e de assistência social, sem fins lucrativos, atendidos os requisitos da lei (CF88, Art 150, VI, c)\r\n* 4 - Livros, jornais, periódicos e o papel destinado a sua impressão (CF88, Art 150, VI, d)\r\n* 5 - Fonogramas e videofonogramas musicais produzidos no Brasil contendo obras musicais ou literomusicais de autores brasileiros e/ou obras em geral interpretadas por artistas brasileiros bem como os suportes materiais ou arquivos digitais que os contenham, salvo na etapa de replicação industrial de mídias ópticas de leitura a laser.   (CF88, Art 150, VI, e)","x-nullable":true},"exigSusp":{"$ref":"#/definitions/ExigSuspensa"},"BM":{"$ref":"#/definitions/BeneficioMunicipal"},"tpRetISSQN":{"type":"integer","description":"Tipo de retencao do ISSQN:\r\n* 1 - Não Retido\r\n* 2 - Retido pelo Tomador\r\n* 3 - Retido pelo Intermediario","default":1,"x-nullable":true},"pAliq":{"type":"number","description":"Valor da alíquota (%%) do serviço prestado relativo ao município sujeito ativo (município de incidência) do ISSQN.\r\n\r\n**Observações**:\r\n* Se o município de incidência pertence ao Sistema Nacional NFS-e a alíquota estará parametrizada e, portanto, será fornecida pelo sistema.\r\n* Se o município de incidência não pertence ao Sistema Nacional NFS-e a alíquota não estará parametrizada e, por isso, deverá ser fornecida pelo emitente.","minimum":0,"x-nullable":true},"cLocIncid":{"type":"string","description":"Código do município de incidência do ISSQN (tabela do IBGE).\r\n\r\nCaso o envio seja pelo Sistema Nacional NFS-e, essa propriedade é ignorada e o município de incidência do ISSQN é determinado automaticamente pela SEFIN nacional, conforme regras do aspecto espacial da lei complementar federal (LC 116/03) que são válidas para todos os municípios.","x-nullable":true},"vBC":{"type":"number","description":"Valor da Base de Cálculo do ISSQN (R$).\r\n\r\nCaso você não informe esse campo, vamos calculá-lo automaticamente.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado e o valor é determinado automaticamente pela SEFIN nacional.","minimum":0,"x-nullable":true},"vISSQN":{"type":"number","description":"Valor do ISSQN (R$).\r\n\r\nCaso você não informe esse campo, vamos calculá-lo automaticamente.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado e o valor é determinado automaticamente pela SEFIN nacional.","minimum":0,"x-nullable":true},"vLiq":{"type":"number","description":"Valor Líquido (R$).\r\n\r\nCaso você não informe esse campo, vamos calculá-lo automaticamente.\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado e o valor é determinado automaticamente pela SEFIN nacional.","minimum":0,"x-nullable":true}},"required":["tribISSQN"]},"ExigSuspensa":{"type":"object","description":"Informações para a suspensão da Exigibilidade do ISSQN.","properties":{"tpSusp":{"type":"integer","description":"Opção para Exigibilidade Suspensa:\r\n* 1 - Exigibilidade Suspensa por Decisão Judicial\r\n* 2 - Exigibilidade Suspensa por Processo Administrativo","x-nullable":true},"nProcesso":{"type":"string","description":"Número do processo judicial ou administrativo de suspensão da exigibilidade.","x-nullable":true}},"required":["nProcesso","tpSusp"]},"BeneficioMunicipal":{"type":"object","description":"Benefício Municipal","properties":{"tpBM":{"type":"integer","description":"Tipo do Benefício Municipal:\r\n* 1 - Alíquota Diferenciada\r\n* 2 - Redução da BC\r\n* 3 - Isenção\r\n\r\n**Atenção**: Para emissões pelo Sistema Nacional NFS-e, esse campo é ignorado.","x-nullable":true},"nBM":{"type":"string","description":"Identificador do benefício parametrizado pelo município.\r\nTrata-se de um identificador único que foi gerado pelo Sistema Nacional no momento em que o município de incidência do ISSQN incluiu o benefício no sistema.\r\nCritério de formação do número de identificação de parâmetros municipais:\r\n7 dígitos - posição 1 a 7: número identificador do Município, conforme código IBGE\r\n2 dígitos - posições 8 e 9 : número identificador do tipo de parametrização (01-legislação, 02-regimes especiais, 03-retenções, 04-outros benefícios)\r\n5 dígitos - posição 10 a 14 : número sequencial definido pelo sistema quando do registro específico do parâmetro dentro do tipo de parametrização no sistema.","x-nullable":true},"vRedBCBM":{"type":"number","description":"Valor monetário informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM).","minimum":0,"x-nullable":true},"pRedBCBM":{"type":"number","description":"Valor percentual informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM).","minimum":0,"x-nullable":true}},"required":["nBM"]},"TribFederal":{"type":"object","description":"Grupo de informações de outros tributos relacionados ao serviço prestado.","properties":{"piscofins":{"$ref":"#/definitions/TribOutrosPisCofins"},"vRetCP":{"type":"number","description":"Valor monetário do CP(R$).","minimum":0,"x-nullable":true},"vRetIRRF":{"type":"number","description":"Valor monetário do IRRF (R$).","minimum":0,"x-nullable":true},"vRetCSLL":{"type":"number","description":"Valor monetário do CSLL (R$).","minimum":0,"x-nullable":true}}},"TribOutrosPisCofins":{"type":"object","description":"Grupo de informações dos tributos PIS/COFINS.","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do PIS/COFINS (CST):\r\n* 00 - Nenhum\r\n* 01 - Operação Tributável com Alíquota Básica\r\n* 02 - Operação Tributável com Alíquota Diferenciada\r\n* 03 - Operação Tributável com Alíquota por Unidade de Medida de Produto\r\n* 04 - Operação Tributável monofásica - Revenda a Alíquota Zero\r\n* 05 - Operação Tributável por Substituição Tributária\r\n* 06 - Operação Tributável a Alíquota Zero\r\n* 07 - Operação Tributável da Contribuição\r\n* 08 - Operação sem Incidência da Contribuição\r\n* 09 - Operação com Suspensão da Contribuição","x-nullable":true},"vBCPisCofins":{"type":"number","description":"Valor da Base de Cálculo do PIS/COFINS (R$).","minimum":0,"x-nullable":true},"pAliqPis":{"type":"number","description":"Valor da Alíquota do PIS (%%).","minimum":0,"x-nullable":true},"pAliqCofins":{"type":"number","description":"Valor da Alíquota da COFINS (%%).","minimum":0,"x-nullable":true},"vPis":{"type":"number","description":"Valor monetário do PIS (R$).","minimum":0,"x-nullable":true},"vCofins":{"type":"number","description":"Valor monetário do COFINS (R$).","minimum":0,"x-nullable":true},"tpRetPisCofins":{"type":"integer","description":"Tipo de retencao do Pis/Cofins:\r\n* 1 - Retido\r\n* 2 - Não Retido","x-nullable":true}},"required":["CST"]},"TribTotal":{"type":"object","description":"Grupo de informações para totais aproximados dos tributos relacionados ao serviço prestado.","properties":{"vTotTrib":{"$ref":"#/definitions/TribTotalMonet"},"pTotTrib":{"$ref":"#/definitions/TribTotalPercent"},"indTotTrib":{"type":"integer","description":"Indicador de informação de valor total de tributos. Possui valor fixo igual a zero (indTotTrib=0).\r\nNão informar nenhum valor estimado para os Tributos (Decreto 8.264/2014).\r\n* 0 - Não","x-nullable":true},"pTotTribSN":{"type":"number","description":"Valor percentual aproximado do total dos tributos da alíquota do Simples Nacional (%%).","minimum":0,"x-nullable":true}}},"TribTotalMonet":{"type":"object","description":"Valor monetário total aproximado dos tributos, em conformidade com o artigo 1o da Lei no 12.741/2012.","properties":{"vTotTribFed":{"type":"number","description":"Valor monetário total aproximado dos tributos federais (R$).","minimum":0,"x-nullable":true},"vTotTribEst":{"type":"number","description":"Valor monetário total aproximado dos tributos estaduais (R$).","minimum":0,"x-nullable":true},"vTotTribMun":{"type":"number","description":"Valor monetário total aproximado dos tributos municipais (R$).","minimum":0,"x-nullable":true}},"required":["vTotTribMun","vTotTribEst","vTotTribFed"]},"TribTotalPercent":{"type":"object","description":"Valor percentual total aproximado dos tributos, em conformidade com o artigo 1o da Lei no 12.741/2012.","properties":{"pTotTribFed":{"type":"number","description":"Valor percentual total aproximado dos tributos federais (%%).","minimum":0,"x-nullable":true},"pTotTribEst":{"type":"number","description":"Valor percentual total aproximado dos tributos estaduais (%%).","minimum":0,"x-nullable":true},"pTotTribMun":{"type":"number","description":"Valor percentual total aproximado dos tributos municipais (%%).","minimum":0,"x-nullable":true}},"required":["pTotTribMun","pTotTribEst","pTotTribFed"]},"RTCInfoIBSCBS":{"type":"object","description":"Grupo de informações declaradas pelo emitente referentes ao IBS e à CBS.","properties":{"finNFSe":{"type":"integer","description":"Indicador da finalidade da emissão de NFS-e:\r\n* 0 - NFS-e regular.","x-nullable":true},"indFinal":{"type":"integer","description":"Indica operação de uso ou consumo pessoal (art. 57):\r\n* 0 - Não;\r\n* 1 - Sim.","x-nullable":true},"cIndOp":{"type":"string","description":"Código indicador da operação de fornecimento, conforme tabela \"código indicador de operação\".","x-nullable":true},"tpOper":{"type":"integer","description":"Tipo de Operação com Entes Governamentais ou outros serviços sobre bens imóveis:\r\n* 1 – Fornecimento com pagamento posterior;\r\n* 2 - Recebimento do pagamento com fornecimento já realizado;\r\n* 3 – Fornecimento com pagamento já realizado;\r\n* 4 – Recebimento do pagamento com fornecimento posterior;\r\n* 5 – Fornecimento e recebimento do pagamento concomitantes.","x-nullable":true},"gRefNFSe":{"$ref":"#/definitions/InfoRefNFSe"},"tpEnteGov":{"type":"integer","description":"Tipo de ente governamental\r\nPara administração pública direta e suas autarquias e fundações:\r\n* 1 - União;\r\n* 2 - Estado;\r\n* 3 - Distrito Federal;\r\n* 4 - Município.","x-nullable":true},"indDest":{"type":"integer","description":"A respeito do Destinatário dos serviços:\r\n* 0 – O destinatário é o próprio tomador/adquirente identificado na NFS-e (tomador = adquirente = destinatário);\r\n* 1 – O destinatário não é o próprio adquirente, podendo ser outra pessoa, física ou jurídica (ou equiparada), ou um estabelecimento diferente do indicado como tomador (tomador = adquirente != destinatário).","x-nullable":true},"dest":{"$ref":"#/definitions/RTCInfoDest"},"imovel":{"$ref":"#/definitions/RTCInfoImovel"},"valores":{"$ref":"#/definitions/RTCInfoValoresIBSCBS"}},"required":["valores","indDest","cIndOp","indFinal","finNFSe"]},"InfoRefNFSe":{"type":"object","description":"Grupo de NFS-e referenciadas.","properties":{"refNFSe":{"type":"array","description":"Chave da NFS-e referenciada.","items":{"type":"string"},"maxItems":99,"minItems":1}},"required":["refNFSe"]},"RTCInfoDest":{"type":"object","description":"Grupo de informações relativas ao Destinatário.","properties":{"CNPJ":{"type":"string","description":"Número da inscrição no Cadastro Nacional de Pessoa Jurídica (CNPJ) do Destinatário do serviço.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número da inscrição no Cadastro de Pessoa Física (CPF) do Destinatário do serviço.","maxLength":11,"x-nullable":true},"NIF":{"type":"string","description":"Número de Identificação Fiscal fornecido por órgão de administração tributária no exterior.","maxLength":40,"minLength":1,"x-nullable":true},"cNaoNIF":{"type":"integer","description":"Motivo para não informação do NIF:\r\n* 0 - Não informado na nota de origem\r\n* 1 - Dispensado do NIF\r\n* 2 - Não exigência do NIF","x-nullable":true},"xNome":{"type":"string","description":"Nome / Nome Empresarial do do Destinatário do serviço.","maxLength":150,"minLength":1,"x-nullable":true},"end":{"$ref":"#/definitions/Endereco"},"fone":{"type":"string","description":"Número do telefone do Destinatário do serviço\r\n(Preencher com o Código DDD + número do telefone. Nas operações com exterior é permitido informar o\r\ncódigo do país + código da localidade + número do telefone).","x-nullable":true},"email":{"type":"string","description":"* E-mail do Destinatário do serviço","maxLength":80,"minLength":1,"x-nullable":true}},"required":["xNome"]},"RTCInfoImovel":{"type":"object","description":"Grupo de informações de operações relacionadas a bens imóveis, exceto obras.","properties":{"inscImobFisc":{"type":"string","description":"Inscrição imobiliária fiscal (código fornecido pela Prefeitura Municipal para a identificação da obra ou para fins de recolhimento do IPTU).","maxLength":30,"minLength":1,"x-nullable":true},"cCIB":{"type":"string","description":"Código do Cadastro Imobiliário Brasileiro - CIB.","maxLength":8,"x-nullable":true},"end":{"$ref":"#/definitions/EnderObraEvento"}}},"RTCInfoValoresIBSCBS":{"type":"object","description":"Grupo de informações relativas aos valores do serviço prestado para IBS e CBS.","properties":{"gReeRepRes":{"$ref":"#/definitions/RTCInfoReeRepRes"},"trib":{"$ref":"#/definitions/RTCInfoTributosIBSCBS"}},"required":["trib"]},"RTCInfoReeRepRes":{"type":"object","description":"Grupo de informações relativas a valores incluídos neste documento e recebidos por motivo de estarem relacionadas\r\na operações de terceiros, objeto de reembolso, repasse ou ressarcimento pelo recebedor, já tributados e aqui referenciados.","properties":{"documentos":{"type":"array","items":{"$ref":"#/definitions/RTCListaDoc"},"maxItems":1000,"minItems":1}},"required":["documentos"]},"RTCListaDoc":{"type":"object","description":"Grupo relativo aos documentos referenciados nos casos de reembolso, repasse e ressarcimento que serão\r\nconsiderados na base de cálculo do ISSQN, do IBS e da CBS.","properties":{"dFeNacional":{"$ref":"#/definitions/RTCListaDocDFe"},"docFiscalOutro":{"$ref":"#/definitions/RTCListaDocFiscalOutro"},"docOutro":{"$ref":"#/definitions/RTCListaDocOutro"},"fornec":{"$ref":"#/definitions/RTCListaDocFornec"},"dtEmiDoc":{"type":"string","format":"date","description":"Data da emissão do documento dedutível\r\nAno, mês e dia (AAAA-MM-DD).","x-nullable":true},"dtCompDoc":{"type":"string","format":"date","description":"Data da competência do documento dedutível\r\nAno, mês e dia (AAAA-MM-DD).","x-nullable":true},"tpReeRepRes":{"type":"string","description":"Tipo de valor incluído neste documento, recebido por motivo de estarem relacionadas a operações de terceiros,\r\nobjeto de reembolso, repasse ou ressarcimento pelo recebedor, já tributados e aqui referenciados.","x-nullable":true},"xTpReeRepRes":{"type":"string","description":"Descrição do reembolso ou ressarcimento quando a opção é\r\n\"99 - Outros reembolsos ou ressarcimentos recebidos por valores pagos relativos a operações por conta e ordem de terceiro\".","maxLength":150,"minLength":1,"x-nullable":true},"vlrReeRepRes":{"type":"number","description":"Valor monetário (total ou parcial, conforme documento informado) utilizado para não inclusão na base de cálculo\r\ndo ISS e do IBS e da CBS da NFS-e que está sendo emitida (R$).","minimum":0,"x-nullable":true}},"required":["vlrReeRepRes","tpReeRepRes","dtCompDoc","dtEmiDoc"]},"RTCListaDocDFe":{"type":"object","description":"Grupo de informações de documentos fiscais eletrônicos que se encontram no repositório nacional.","properties":{"tipoChaveDFe":{"type":"integer","description":"Documento fiscal a que se refere a chaveDfe que seja um dos documentos do Repositório Nacional.","x-nullable":true},"xTipoChaveDFe":{"type":"string","description":"Descrição da DF-e a que se refere a chaveDfe que seja um dos documentos do Repositório Nacional\r\nDeve ser preenchido apenas quando \"tipoChaveDFe = 9 (Outro)\".","maxLength":255,"minLength":1,"x-nullable":true},"chaveDFe":{"type":"string","description":"Chave do Documento Fiscal eletrônico do repositório nacional referenciado para os casos de operações já tributadas.","maxLength":50,"minLength":1,"x-nullable":true}},"required":["chaveDFe","tipoChaveDFe"]},"RTCListaDocFiscalOutro":{"type":"object","description":"Grupo de informações de documento fiscais, eletrônicos ou não, que não se encontram no repositório nacional.","properties":{"cMunDocFiscal":{"type":"integer","description":"Código do município emissor do documento fiscal que não se encontra no repositório nacional.","maximum":9999999,"minimum":0,"x-nullable":true},"nDocFiscal":{"type":"string","description":"Número do documento fiscal que não se encontra no repositório nacional.","maxLength":255,"minLength":1,"x-nullable":true},"xDocFiscal":{"type":"string","description":"Descrição do documento fiscal.","maxLength":255,"minLength":1,"x-nullable":true}},"required":["xDocFiscal","nDocFiscal","cMunDocFiscal"]},"RTCListaDocOutro":{"type":"object","description":"Grupo de informações de documento não fiscal.","properties":{"nDoc":{"type":"string","description":"Número do documento não fiscal.","maxLength":255,"minLength":1,"x-nullable":true},"xDoc":{"type":"string","description":"Descrição do documento não fiscal.","maxLength":255,"minLength":1,"x-nullable":true}},"required":["xDoc","nDoc"]},"RTCListaDocFornec":{"type":"object","description":"Grupo de informações do fornecedor do documento referenciado.","properties":{"CNPJ":{"type":"string","description":"Número da inscrição no Cadastro Nacional de Pessoa Jurídica (CNPJ) do Fornecedor do serviço.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número da inscrição no Cadastro de Pessoa Física (CPF) do Fornecedor do serviço.","maxLength":11,"x-nullable":true},"NIF":{"type":"string","description":"Este elemento só deverá ser preenchido para fornecedores não residentes no Brasil.","maxLength":40,"minLength":1,"x-nullable":true},"cNaoNIF":{"type":"integer","description":"Motivo para não informação do NIF:\r\n* 0 - Não informado na nota de origem\r\n* 1 - Dispensado do NIF\r\n* 2 - Não exigência do NIF","x-nullable":true},"xNome":{"type":"string","description":"Nome / Razão Social do do Fornecedor do serviço.","maxLength":150,"minLength":1,"x-nullable":true}},"required":["xNome"]},"RTCInfoTributosIBSCBS":{"type":"object","description":"Grupo de informações relacionados aos tributos IBS e CBS.","properties":{"gIBSCBS":{"$ref":"#/definitions/RTCInfoTributosSitClas"}},"required":["gIBSCBS"]},"RTCInfoTributosSitClas":{"type":"object","description":"Grupo de informações relacionadas ao IBS e à CBS.","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do IBS e da CBS.","x-nullable":true},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e da CBS.","x-nullable":true},"cCredPres":{"type":"string","description":"Código e Classificação do Crédito Presumido: IBS e CBS.","x-nullable":true},"gTribRegular":{"$ref":"#/definitions/RTCInfoTributosTribRegular"},"gDif":{"$ref":"#/definitions/RTCInfoTributosDif"}},"required":["cClassTrib","CST"]},"RTCInfoTributosTribRegular":{"type":"object","description":"Grupo de informações da Tributação Regular.","properties":{"CSTReg":{"type":"string","description":"Código de Situação Tributária do IBS e da CBS de tributação regular.","x-nullable":true},"cClassTribReg":{"type":"string","description":"Código da Classificação Tributária do IBS e da CBS de tributação regular.","x-nullable":true}},"required":["cClassTribReg","CSTReg"]},"RTCInfoTributosDif":{"type":"object","description":"Grupo de informações relacionadas ao diferimento para IBS e CBS.","properties":{"pDifUF":{"type":"number","description":"Percentual de diferimento para o IBS estadual.","minimum":0,"x-nullable":true},"pDifMun":{"type":"number","description":"Percentual de diferimento para o IBS municipal.","minimum":0,"x-nullable":true},"pDifCBS":{"type":"number","description":"Percentual de diferimento para a CBS.","minimum":0,"x-nullable":true}},"required":["pDifCBS","pDifMun","pDifUF"]},"RpsLoteListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/RpsLote"}}}},"NfsePedidoEmissao":{"type":"object","properties":{"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"rps":{"$ref":"#/definitions/RpsPedidoEmissao"}},"required":["rps","ambiente"]},"NfseListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/Nfse"}}}},"NfsePedidoCancelamento":{"type":"object","properties":{"codigo":{"type":"string","description":"Código de cancelamento, exigido por algumas prefeituras.\r\nPara saber quais valores são aceitos, consulte o manual da prefeitura."},"motivo":{"type":"string","description":"Motivo de cancelamento, exigido por algumas prefeituras."}}},"NfsePedidoSincronizacao":{"type":"object","properties":{"identificador":{"type":"string","description":"Identificador utilizado na consulta da situação atual da NFS-e.\r\n\r\nO valor desse campo é opcional para as prefeituras que suportem consultas por número e série do RPS.\r\nPara as demais, esse campo torna-se obrigatório e o seu valor pode ser a chave de acesso, número da NFS-e, chave de verificação, protocolo ou outro identificador da nota a depender da prefeitura."}}},"NfseSincronizacao":{"type":"object","properties":{"status":{"type":"string","description":"Situação atual da sincronização.","enum":["pendente","sincronizado","erro"]},"mensagens":{"type":"array","items":{"$ref":"#/definitions/NfseMensagemRetorno"}}}},"DfeDebug":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do documento fiscal."},"tipo":{"type":"string","description":"Tipo do documento: nfe, nfce, mdfe, nfse, etc."},"created_at":{"type":"string","format":"date-time","description":"Data e hora da criação do documento, representada no formato UTC (Tempo Universal Coordenado).\r\nO valor é retornado no padrão ISO 8601, incluindo o deslocamento de fuso horário 'Z' no final.\r\n\r\nExemplo: \"2025-04-15T14:16:47.775Z\""},"requisicoes":{"type":"array","description":"Lista de requisições feitas ao autorizador durante o processamento.","items":{"$ref":"#/definitions/DfeRequisicaoDebug"}}}},"DfeRequisicaoDebug":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Data e hora da criação da requisição, representada no formato UTC (Tempo Universal Coordenado).\r\nO valor é retornado no padrão ISO 8601, incluindo o deslocamento de fuso horário 'Z' no final.\r\n\r\nExemplo: \"2025-04-15T14:16:47.775Z\""},"tipo":{"type":"string","description":"Tipo da operação realizada na requisição para o autorizador.\r\nPode assumir um dos seguintes valores:\r\n- 'envio_lote'      : envio do lote de documentos fiscais para autorização;\r\n- 'consulta_lote'   : consulta do processamento do lote;\r\n- 'cons_sit_dfe'    : consulta de situação individual de um DFe.\r\n\r\nEsse campo indica a natureza da interação com a SEFAZ ou prefeitura,\r\ne é útil para fins de rastreamento e diagnóstico do fluxo."},"lote_id":{"type":"string","description":"Identificador do lote vinculado à requisição."},"codigo_status":{"type":"integer","description":"Código de status retornado pela SEFAZ/prefeitura."},"motivo_status":{"type":"string","description":"Motivo associado ao status retornado."},"http_request":{"$ref":"#/definitions/HttpRequestDebug"}}},"HttpRequestDebug":{"type":"object","description":"Detalhes técnicos da requisição HTTP realizada ao autorizador.","properties":{"id":{"type":"string","description":"Identificador interno da requisição HTTP.\r\n\r\nEsse identificador pode ser utilizado no endpoint\r\n<a href=\"#tag/Debug/operation/DebugHttpRequestContent\">Corpo da Requisição HTTP</a> ou <a href=\"#tag/Debug/operation/DebugHttpResponseContent\">Corpo da Resposta HTTP</a>\r\npara obter o conteúdo enviado ou recebido na comunicação com o autorizador."},"method":{"type":"string","description":"Método HTTP utilizado (ex: 'POST')."},"uri":{"type":"string","description":"URI do serviço externo (SEFAZ, prefeitura, etc.)."},"headers":{"type":"string","description":"Cabeçalhos HTTP enviados na requisição, no formato bruto."},"response_status_code":{"type":"integer","description":"Código de status HTTP retornado (ex: 200, 403)."},"response_status_reason":{"type":"string","description":"Motivo ou descrição do status HTTP retornado."},"response_headers":{"type":"string","description":"Cabeçalhos retornados na resposta, no formato bruto."},"response_time":{"type":"integer","description":"Tempo de resposta do serviço externo, em milissegundos."}}},"DcePedidoEmissao":{"type":"object","properties":{"infDCe":{"$ref":"#/definitions/DceSefazInfDCe"},"infSolicDCe":{"$ref":"#/definitions/DceSefazInfSolicDCe"},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true}},"required":["ambiente","infSolicDCe","infDCe"]},"DceSefazInfDCe":{"type":"object","description":"Informações da DCe.","properties":{"versao":{"type":"string","description":"Versão do leiaute.","x-nullable":true},"Id":{"type":"string","description":"Identificador da tag a ser assinada.\r\nInformar a chave de acesso precedida do literal \"DCe\".\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"ide":{"$ref":"#/definitions/DceSefazIde"},"emit":{"$ref":"#/definitions/DceSefazEmit"},"Fisco":{"$ref":"#/definitions/DceSefazFisco"},"Marketplace":{"$ref":"#/definitions/DceSefazMarketplace"},"Transportadora":{"$ref":"#/definitions/DceSefazTransportadora"},"ECT":{"$ref":"#/definitions/DceSefazECT"},"dest":{"$ref":"#/definitions/DceSefazDest"},"autXML":{"type":"array","items":{"$ref":"#/definitions/DceSefazAutXML"},"maxItems":10},"det":{"type":"array","items":{"$ref":"#/definitions/DceSefazDet"},"maxItems":999,"minItems":1},"total":{"$ref":"#/definitions/DceSefazTotal"},"transp":{"$ref":"#/definitions/DceSefazTransp"},"infAdic":{"$ref":"#/definitions/DceSefazInfAdic"},"infDec":{"$ref":"#/definitions/DceSefazInfDec"}},"required":["transp","total","det","dest","emit","ide","versao"]},"DceSefazIde":{"type":"object","description":"Identificação da DCe.","properties":{"cUF":{"type":"integer","description":"Código da UF de emissão e autorização da DCe.\r\nCódigo da UF de emissão e autorização do Documento Fiscal. Utilizar a\r\nTabela do IBGE de código de unidades da federação.","x-nullable":true},"cDC":{"type":"string","description":"Código numérico que compõe a Chave de Acesso.\r\nCódigo aleatório gerado pelo emitente, com o objetivo de evitar acessos indevidos ao documento.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"mod":{"type":"integer","description":"Modelo da DCe.\r\nUtilizar o código 99 para identificação da DCe.","x-nullable":true},"serie":{"type":"integer","description":"Série do documento fiscal.\r\nInformar a série do documento fiscal (informar zero para série única).","maximum":999,"minimum":0,"x-nullable":true},"nDC":{"type":"integer","description":"Número do documento fiscal.\r\nNúmero que identifica o documento fiscal 1 a 999999999.","maximum":999999999,"minimum":1,"x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e hora de emissão do documento fiscal.\r\nFormato UTC (AAAA-MM-DDThh:mm:ssTZD, onde TZD = +hh:mm ou -hh:mm).","x-nullable":true},"tpEmis":{"type":"integer","description":"Forma de emissão do Documento Fiscal.\r\n* 1 - Normal (não contingência)\r\n* 9 - Contingência off-line da DCe","x-nullable":true},"tpEmit":{"type":"integer","description":"Tipo do Emitente da DCe.\r\n* 0 - App Fisco\r\n* 1 - Marketplace\r\n* 2 - Emissor próprio\r\n* 3 - Transportadora\r\n* 4 - ECT","maximum":4,"minimum":0,"x-nullable":true},"nSiteAutoriz":{"type":"integer","description":"Identificação do número do Site do Autorizador de recepção da DCe.\r\nSe o autorizador da DCe possuir apenas um site deverá ser informado com Zero (0), em caso de Autorizador trabalhar com múltiplos sites indicar o número do site para qual foi endereçada a DCE (1 a 9).\r\nObservação: o ambiente autorizador que trabalhar com mais de um Site deverá divulgar para cada endereço de site qual número correspondente de nSiteAutoriz o contribuinte pode usar.","maximum":9,"minimum":0,"x-nullable":true},"cDV":{"type":"integer","description":"Digito verificador da chave de acesso.\r\nInformar o dígito de controle da chave de acesso documento fiscal, que deve ser calculado com a aplicação do algoritmo módulo 11 (base 2,9) da chave de acesso.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maximum":9,"minimum":0,"x-nullable":true},"tpAmb":{"type":"integer","description":"Tipo do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"verProc":{"type":"string","description":"Versão do processo de emissão.\r\nInformar a versão do aplicativo emissor de DCe.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["verProc","nSiteAutoriz","tpEmit","tpEmis","dhEmi","nDC","serie","cUF"]},"DceSefazEmit":{"type":"object","description":"Identificação da DCe.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ do emitente.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF do emitente.\r\nInformar os zeros não significativos.","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou Nome do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"enderEmit":{"$ref":"#/definitions/DceSefazEndeEmi"}}},"DceSefazEndeEmi":{"type":"object","description":"Endereço do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","properties":{"xLgr":{"type":"string","description":"Logradouro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"cPais":{"type":"string","description":"Código do País.\r\n* 1058=Brasil","x-nullable":true},"xPais":{"type":"string","description":"Nome do País exemplo: Brasil ou BRASIL.","x-nullable":true},"fone":{"type":"string","description":"Telefone.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}},"required":["xPais","cPais"]},"DceSefazFisco":{"type":"object","description":"Identificação do Fisco (uso exclusivo fisco).","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ do órgão.","x-nullable":true},"xOrgao":{"type":"string","description":"Nome do órgão.","maxLength":60,"minLength":2,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.","x-nullable":true}},"required":["UF","xOrgao","CNPJ"]},"DceSefazMarketplace":{"type":"object","description":"Identificação do Marketplace (uso exclusivo Marketplace).","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ do Marketplace.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do Marketplace.","maxLength":60,"minLength":2,"x-nullable":true},"Site":{"type":"string","description":"Endereço ou site do Marketplace.","maxLength":120,"minLength":2,"x-nullable":true}},"required":["Site","xNome","CNPJ"]},"DceSefazTransportadora":{"type":"object","description":"Identificação da Transportadora (uso exclusivo Transportadora).","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ da Transportadora.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome da Transportadora.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["xNome","CNPJ"]},"DceSefazECT":{"type":"object","description":"Identificação dos correios.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ dos correios.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome dos correios.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["xNome","CNPJ"]},"DceSefazDest":{"type":"object","description":"Identificação do destinatário da DCe.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"idOutros":{"type":"string","description":"Identificação do destinatário outros.\r\nIdentificação do destinatário não obrigado a inscrição do CPF tais como estrangeiro, indígena e quilombola\r\nEm caso de não contar CPF do assinante, informar o RG.","maxLength":20,"minLength":2,"x-nullable":true},"xNome":{"type":"string","description":"Razão social ou Nome do destinatário.","maxLength":60,"minLength":2,"x-nullable":true},"enderDest":{"$ref":"#/definitions/DceSefazEndeDest"}},"required":["enderDest","xNome"]},"DceSefazEndeDest":{"type":"object","description":"Endereço do destinatário / assinante.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.","maxLength":60,"minLength":2,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.","x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.","x-nullable":true},"cPais":{"type":"string","description":"Código do país.\r\nUtilizar a tabela do BACEN.","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"email":{"type":"string","description":"Endereço de E-mail.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xPais","cPais","CEP","UF","xMun","cMun","xBairro","nro","xLgr"]},"DceSefazAutXML":{"type":"object","description":"Autorizados para acessar o XML da DCe.\r\nInformar CNPJ ou CPF. Preencher os zeros não significativos.","properties":{"CNPJ":{"type":"string","description":"CNPJ do autorizado.\r\nInformar zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"CPF do autorizado.\r\nInformar zeros não significativos.","x-nullable":true}}},"DceSefazDet":{"type":"object","description":"Detalhamento de itens da DCe.","properties":{"nItem":{"type":"integer","description":"Número do item da DCe.","maximum":9999,"minimum":1,"x-nullable":true},"prod":{"$ref":"#/definitions/DceSefazProd"},"infAdProd":{"type":"string","description":"Informações adicionais do item.","maxLength":500,"minLength":1,"x-nullable":true}},"required":["prod","nItem"]},"DceSefazProd":{"type":"object","description":"Dados do Produto ou Serviço.","properties":{"xProd":{"type":"string","description":"Descrição do produto, bem ou mercadoria.","maxLength":120,"minLength":1,"x-nullable":true},"NCM":{"type":"string","description":"Código NCM.\r\nCapítulo do Código NCM com 2 dígitos ou NCM completo.","x-nullable":true},"qCom":{"type":"number","description":"Quantidade.","minimum":0,"x-nullable":true},"vUnCom":{"type":"number","description":"Valor unitário do item.","x-nullable":true},"vProd":{"type":"number","description":"Valor total brutp do item.","x-nullable":true}},"required":["vProd","vUnCom","qCom","NCM","xProd"]},"DceSefazTotal":{"type":"object","description":"Dados dos totais da DCe.","properties":{"vDC":{"type":"number","description":"Valor Total da DCe.","minimum":0,"x-nullable":true}},"required":["vDC"]},"DceSefazTransp":{"type":"object","description":"Dados dos transportes da DCe.","properties":{"modTrans":{"type":"integer","description":"Modalidade do transporte.\r\n* 0 - Transporte pelos correios\r\n* 1 - Transporte por contra própria\r\n* 2 - Transporte por empresa transportadora","x-nullable":true},"CNPJTransp":{"type":"string","description":"Número do CNPJ da Transportadora.","x-nullable":true}},"required":["CNPJTransp","modTrans"]},"DceSefazInfAdic":{"type":"object","description":"Informações Adicionais.","properties":{"infAdFisco":{"type":"string","description":"Informações adicionais de interesse do Fisco.\r\nNorma referenciada, informações complementares, etc.","maxLength":2000,"minLength":1,"x-nullable":true},"infCpl":{"type":"string","description":"Informações complementares de interesse do Emitente.","maxLength":5000,"minLength":1,"x-nullable":true},"infAdMarketplace":{"type":"string","description":"Informações Adicionais do MarketPlace.","maxLength":5000,"minLength":1,"x-nullable":true},"infAdECT":{"type":"string","description":"Informações Adicionais do Correio.","maxLength":5000,"minLength":1,"x-nullable":true},"obsEmit":{"type":"array","items":{"$ref":"#/definitions/DceSefazObsEmit"},"maxItems":10},"obsFisco":{"type":"array","items":{"$ref":"#/definitions/DceSefazObsFisco"},"maxItems":10},"obsMarketplace":{"type":"array","items":{"$ref":"#/definitions/DceSefazObsMarketplace"},"maxItems":10},"obsECT":{"type":"array","items":{"$ref":"#/definitions/DceSefazObsECT"},"maxItems":10}}},"DceSefazObsEmit":{"type":"object","description":"Grupo Campo de uso livre do Emitente.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no xTexto.","properties":{"xCampo":{"type":"string","x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do Campo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTexto"]},"DceSefazObsFisco":{"type":"object","description":"Grupo Campo de uso livre do Fisco.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no xTexto.","properties":{"xCampo":{"type":"string","x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do Campo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTexto"]},"DceSefazObsMarketplace":{"type":"object","description":"Grupo Campo de uso livre do MarketPlace.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no xTexto.","properties":{"xCampo":{"type":"string","x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do Campo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTexto"]},"DceSefazObsECT":{"type":"object","description":"Grupo Campo de uso livre dos Correios.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no xTexto.","properties":{"xCampo":{"type":"string","x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do Campo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTexto"]},"DceSefazInfDec":{"type":"object","description":"Grupo para Declaraçao do usuário emitente.","properties":{"xObs1":{"type":"string","description":"Observação 1 ao usuário emitente.\r\nDeverá conter o texto fixo “É contribuinte de ICMS qualquer pessoa física ou jurídica, que realize, com habitualidade ou em volume que caracterize intuito comercial, operações de circulação de mercadoria ou prestações de serviços de transportes interestadual e intermunicipal e de comunicação, ainda que as operações e prestações de iniciem no exterior (Lei Complementar nº 87/96, Art. 4º)”.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":2000,"minLength":1,"x-nullable":true},"xObs2":{"type":"string","description":"Observação 2 ao usuário emitente.\r\nDeverá conter o texto fixo “Constitui crime contra a ordem tributária suprimir ou reduzir tributo, ou contribuição social e qualquer acessório: quando negar ou deixar de fornecer, quando obrigatório, nota fiscal ou documento equivalente, relativa a venda de mercadoria ou prestação de serviço, efetivamente realizada ou fornece-la em desacordo com a legislação. Sob pena de reclusão de 2 (dois) e 5 (cinco) anos, e multa (Lei 8.137/90, Art 1ª, V)”.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":5000,"minLength":1,"x-nullable":true}}},"DceSefazInfSolicDCe":{"type":"object","description":"Informações de solicitação da DCe pelo Fisco.","properties":{"xSolic":{"type":"string","description":"Solicitação do pedido de emissão da DCe.","maxLength":2000,"minLength":0,"x-nullable":true}},"required":["xSolic"]},"DcePedidoCancelamento":{"type":"object","properties":{"justificativa":{"type":"string","description":"Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco."}}},"EmailListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/EmailResumo"}}}},"EmailResumo":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para este email.\r\n\r\nUtilize-o no endpoint de <a href=\"#tag/Email/operation/ConsultarEmail\">consulta de email</a>\r\npara obter informações detalhadas sobre o envio do email e\r\nrastrear todos os eventos relacionados, como envio, entrega, falhas e outros\r\neventos relevantes."},"status":{"type":"string","enum":["pending","sending","sent","delivered","delivery_delayed","bounced","complained","rejected","cancelled","failed"]},"sent_at":{"type":"string","format":"date-time","x-nullable":true},"recipients":{"type":"array","items":{"type":"string"}},"subject":{"type":"string"}},"required":["id"]},"Email":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para este email.\r\n\r\nUtilize-o no endpoint de <a href=\"#tag/Email/operation/ConsultarEmail\">consulta de email</a>\r\npara obter informações detalhadas sobre o envio do email e\r\nrastrear todos os eventos relacionados, como envio, entrega, falhas e outros\r\neventos relevantes."},"status":{"type":"string","enum":["pending","sending","sent","delivered","delivery_delayed","bounced","complained","rejected","cancelled","failed"]},"sent_at":{"type":"string","format":"date-time","x-nullable":true},"to":{"type":"array","items":{"type":"string"}},"cc":{"type":"array","items":{"type":"string"}},"reply_to":{"type":"string"},"subject":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/EmailAttachment"}},"events":{"type":"array","items":{"$ref":"#/definitions/EmailEvent"}}},"required":["id"]},"EmailAttachment":{"type":"object","properties":{"content_type":{"type":"string","maxLength":100},"filename":{"type":"string"}}},"EmailEvent":{"type":"object","properties":{"id":{"type":"string"},"event_type":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"message":{"type":"string","x-nullable":true}}},"DistribuicaoNfeListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/DistribuicaoNfe"}}}},"DistribuicaoNfe":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para o pedido de distribuição."},"created_at":{"type":"string","format":"date-time","description":"Data/hora em que o pedido foi criado na API. Representado no formato <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"blank\">`ISO 8601`</a>."},"status":{"type":"string","description":"Indica o status da distribuição.","enum":["processando","concluido","erro"]},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"uf_autor":{"type":"string","description":"Sigla da UF do autor.","x-nullable":true},"tipo_consulta":{"type":"string","enum":["dist-nsu","cons-nsu","cons-chave"]},"dist_nsu":{"type":"integer","format":"int64","description":"Distribuição de conjunto de DF-e a partir do NSU informado.\r\n\r\n*Obrigatório quando `tipo_consulta` for `distNSU`.*","x-nullable":true},"cons_nsu":{"type":"integer","format":"int64","description":"Consulta DF-e vinculado ao NSU informado.\r\n\r\n*Obrigatório quando `tipo_consulta` for `consNSU`.*","x-nullable":true},"cons_chave":{"type":"string","description":"Consulta de NF-e por chave de acesso informada.\r\n\r\n*Obrigatório quando `tipo_consulta` for `consChNFe`.*","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de processamento da requisição.","x-nullable":true},"motivo_status":{"type":"string","description":"Descrição do status de processamento da requisição.","x-nullable":true},"data_hora_resposta":{"type":"string","format":"date-time","description":"Data e Hora de processamento da requisição.","x-nullable":true},"ultimo_nsu":{"type":"integer","format":"int64","description":"Último NSU pesquisado no Ambiente Nacional. Se for o caso, o solicitante pode continuar a consulta a partir deste NSU para obter novos resultados.","x-nullable":true},"max_nsu":{"type":"integer","format":"int64","description":"Maior NSU existente no Ambiente Nacional para o CNPJ/CPF informado.","x-nullable":true},"documentos":{"type":"array","description":"Conjunto de informações resumidas e documentos fiscais eletrônicos de interesse da pessoa ou empresa.","items":{"$ref":"#/definitions/DistribuicaoNfeDocumento"},"maxItems":50}},"required":["max_nsu","ultimo_nsu","data_hora_resposta","codigo_status","tipo_consulta","ambiente","status","id"]},"DistribuicaoNfeDocumento":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para identificar o documento."},"created_at":{"type":"string","format":"date-time","description":"Data/hora em que o documento foi criado na API. Representado no formato <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"blank\">`ISO 8601`</a>."},"nsu":{"type":"integer","format":"int64","description":"NSU do documento fiscal.","x-nullable":true},"schema":{"type":"string","description":"Identificação do Schema XML que será utilizado para validar o XML existente no conteúdo da tag docZip. Vai identificar o tipo do documento e sua versão. Exemplos: resNFe_v1.00.xsd, procNFe_v3.10.xsd, resEvento_1.00.xsd, procEventoNFe_v1.00.xsd."},"tipo_documento":{"type":"string","description":"Tipo do documento de interesse da pessoa ou empresa.","enum":["nota","evento"],"x-nullable":true},"chave_acesso":{"type":"string","description":"Chave de Acesso da NF-e.","x-nullable":true},"resumo":{"type":"boolean","description":"Indica se o documento distribuído está em sua forma resumida.","x-nullable":true},"tipo_evento":{"type":"string","description":"Tipo do evento.","x-nullable":true},"numero_sequencial":{"type":"integer","description":"Número sequencial do evento para o mesmo tipo de evento.","x-nullable":true},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do evento.","x-nullable":true},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora de autorização do evento.","x-nullable":true},"numero_protocolo":{"type":"string","description":"Número do protocolo de autorização.","x-nullable":true},"tipo_nfe":{"type":"integer","description":"Tipo da NF-e (0 - entrada; 1 - saída).","x-nullable":true},"valor_nfe":{"type":"number","description":"Valor total da NF-e.","x-nullable":true},"digest_value":{"type":"string","description":"Digest Value da NF-e processada. Utilizado para conferir a integridade da NF-e original.","x-nullable":true},"emitente_cpf_cnpj":{"type":"string","description":"CPF/CNPJ do emitente.","x-nullable":true},"emitente_nome_razao_social":{"type":"string","description":"Nome ou Razão Social do emitente.","x-nullable":true},"emitente_inscricao_estadual":{"type":"string","description":"Inscrição Estadual do emitente.","x-nullable":true}},"required":["schema","id"]},"DistribuicaoNfePedido":{"type":"object","properties":{"cpf_cnpj":{"type":"string","description":"CPF ou CNPJ da empresa.\r\n\r\n*Utilize o valor sem máscara*."},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"uf_autor":{"type":"string","description":"Sigla da UF do autor.","x-nullable":true},"tipo_consulta":{"type":"string","description":"Tipo de consulta.\n\r\nValores possíveis:\n* `dist-nsu` - Consulta pelo último NSU recebido.\n* `cons-nsu` - Consulta por um NSU específico.\n* `cons-chave` - Consulta pela chave de acesso da NF-e.","enum":["dist-nsu","cons-nsu","cons-chave"]},"dist_nsu":{"type":"integer","format":"int64","description":"Distribuição de conjunto de DF-e a partir do NSU informado.\r\n\r\n*Obrigatório quando \"tipo_consulta\" for \"dist-nsu\".*","x-nullable":true},"cons_nsu":{"type":"integer","format":"int64","description":"Consulta DF-e vinculado ao NSU informado.\r\n\r\n*Obrigatório quando \"tipo_consulta\" for \"cons-nsu\".*","x-nullable":true},"cons_chave":{"type":"string","description":"Consulta de NF-e por chave de acesso informada.\r\n\r\n*Obrigatório quando \"tipo_consulta\" for \"cons-chave\".*","x-nullable":true},"ignorar_tempo_espera":{"type":"boolean","description":"Deve ser utilizado em situações em que o cliente\r\ndeseja ignorar o intervalo mínimo de 1 hora entre pedidos de distribuição\r\nde NF-e. Quando habilitado, o cliente reconhece os riscos associados,\r\nincluindo o bloqueio do CNPJ no Ambiente Nacional da SEFAZ, caso seja\r\ncaracterizado consumo indevido.\r\n\r\nValores:\r\n* `false`: Respeita a regra de intervalo mínimo de 1 hora entre consultas\r\n  quando não há mais documentos disponíveis.\r\n\r\n* `true`: Ignora o tempo de espera e força a requisição.","default":false}},"required":["tipo_consulta","ambiente","cpf_cnpj"]},"DistribuicaoNfeDocumentoListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/DistribuicaoNfeDocumento"}}}},"DistribuicaoNfeNotaListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/DistribuicaoNfeNota"}}}},"DistribuicaoNfeNota":{"type":"object","properties":{"chave_acesso":{"type":"string","description":"Chave de Acesso da NF-e.","x-nullable":true},"numero_protocolo":{"type":"string","description":"Número do protocolo de autorização.","x-nullable":true},"tipo_nfe":{"type":"integer","description":"Tipo da NF-e (0 - entrada; 1 - saída).","x-nullable":true},"data_emissao":{"type":"string","format":"date-time","description":"Data e hora da emissão do documento fiscal.","x-nullable":true},"valor_nfe":{"type":"number","description":"Valor total da NF-e.","x-nullable":true},"digest_value":{"type":"string","description":"Digest Value da NF-e processada. Utilizado para conferir a integridade da NF-e original.","x-nullable":true},"emitente_cpf_cnpj":{"type":"string","description":"CPF/CNPJ do emitente.","x-nullable":true},"emitente_nome_razao_social":{"type":"string","description":"Nome ou Razão Social do emitente.","x-nullable":true},"emitente_inscricao_estadual":{"type":"string","description":"Inscrição Estadual do emitente.","x-nullable":true}}},"ManifestacaoNfeListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/DistribuicaoNfeEvento"}}}},"DistribuicaoNfeEvento":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para este evento."},"created_at":{"type":"string","format":"date-time","description":"Data/hora em que o evento foi criado na API. Representado no formato <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"blank\">`ISO 8601`</a>."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"cpf_cnpj_autor":{"type":"string","description":"CPF/CNPJ do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"tipo_evento":{"type":"string","description":"Tipo do evento vinculado."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento.","x-nullable":true},"justificativa":{"type":"string","description":"Justificativa para o desconhecimento ou não-realização da operação.","x-nullable":true},"data_registro":{"type":"string","format":"date-time","description":"Data e hora do registro do evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do evento.","x-nullable":true},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do evento.","x-nullable":true},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do evento.","x-nullable":true}}},"DistribuicaoNfePedidoManifestacao":{"type":"object","properties":{"cpf_cnpj":{"type":"string","description":"CPF ou CNPJ do autor do evento.\r\n\r\n*Utilize o valor sem máscara*."},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"chave_acesso":{"type":"string","description":"Chave de Acesso da NF-e."},"tipo_evento":{"type":"string","description":"Tipo do evento de manifestação do destinatário.\r\n\r\nValores disponíveis:\r\n* `210200` - Confirmação da operação;\r\n* `210210` - Ciência da operação;\r\n* `210220` - Desconhecimento da operação;\r\n* `210240` - Operação não realizada."},"justificativa":{"type":"string","description":"Justificativa para o desconhecimento ou não-realização da operação.\r\n\r\n**Nota**: Campo obrigatório para o evento `210240` (operação não realizada).","maxLength":255,"minLength":15,"x-nullable":true}},"required":["tipo_evento","chave_acesso","ambiente","cpf_cnpj"]},"NfcomPedidoEmissao":{"type":"object","properties":{"infNFCom":{"$ref":"#/definitions/NfcomSefazInfNFCom"},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true}},"required":["ambiente","infNFCom"]},"NfcomSefazInfNFCom":{"type":"object","description":"Informações da NFCom.","properties":{"versao":{"type":"string","description":"Versão do leiaute.","x-nullable":true},"Id":{"type":"string","description":"Identificador da tag a ser assinada.\r\nInformar a chave de acesso da NFCom e precedida do literal \"NFCom\".\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"ide":{"$ref":"#/definitions/NfcomSefazIde"},"emit":{"$ref":"#/definitions/NfcomSefazEmit"},"dest":{"$ref":"#/definitions/NfcomSefazDest"},"assinante":{"$ref":"#/definitions/NfcomSefazAssinante"},"gSub":{"$ref":"#/definitions/NfcomSefazGSub"},"gCofat":{"$ref":"#/definitions/NfcomSefazGCofat"},"det":{"type":"array","items":{"$ref":"#/definitions/NfcomSefazDet"},"maxItems":990,"minItems":1},"total":{"$ref":"#/definitions/NfcomSefazTotal"},"gFidelidade":{"$ref":"#/definitions/NfcomSefazGFidelidade"},"gFat":{"$ref":"#/definitions/NfcomSefazGFat"},"gFatCentral":{"$ref":"#/definitions/NfcomSefazGFatCentral"},"autXML":{"type":"array","items":{"$ref":"#/definitions/NfcomSefazAutXML"},"maxItems":10},"infAdic":{"$ref":"#/definitions/NfcomSefazInfAdic"},"gRespTec":{"$ref":"#/definitions/NfcomSefazRespTec"}},"required":["total","det","assinante","dest","emit","ide","versao"]},"NfcomSefazIde":{"type":"object","description":"Identificação da NFCom.","properties":{"cUF":{"type":"integer","description":"Código da UF de emissão e autorização da NFCom.\r\nCódigo da UF de emissão e autorização do Documento Fiscal. Utilizar a\r\nTabela do IBGE de código de unidades da federação.","x-nullable":true},"tpAmb":{"type":"integer","description":"Tipo do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"mod":{"type":"integer","description":"Modelo da NFCom.\r\nUtilizar o código 62 para identificação da NFCom.","x-nullable":true},"serie":{"type":"integer","description":"Série do documento fiscal.\r\nInformar a série do documento fiscal (informar zero para série única).","maximum":999,"minimum":0,"x-nullable":true},"nNF":{"type":"integer","description":"Número do documento fiscal.\r\nNúmero que identifica o documento fiscal 1 a 999999999.","maximum":999999999,"minimum":1,"x-nullable":true},"cNF":{"type":"string","description":"Código numérico que compõe a Chave de Acesso.\r\nCódigo aleatório gerado pelo emitente, com o objetivo de evitar acessos indevidos ao documento.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"cDV":{"type":"integer","description":"Digito verificador da chave de acesso.\r\nInformar o dígito  de controle da chave de acesso documento fiscal, que deve ser calculado com a aplicação do algoritmo módulo 11 (base 2,9) da chave de acesso.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maximum":9,"minimum":0,"x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e hora de emissão do documento fiscal.\r\nFormato AAAA-MM-DDTHH:MM:DD TZD.","x-nullable":true},"tpEmis":{"type":"integer","description":"Forma de emissão do Documento Fiscal.\r\n* 1 - Normal\r\n* 2 - Contingência","x-nullable":true},"nSiteAutoriz":{"type":"integer","description":"Identificação do número do Site do Autorizador de recepção da NFCom.\r\nSe o autorizador da NFCom possuir apenas um site deverá ser informado com Zero (0), em caso de Autorizador trabalhar com múltiplos sites indicar o número do site para qual foi endereçada a NFCOM (1 a 9).\r\nObservação: o ambiente autorizador que trabalhar com mais de um Site deverá divulgar para cada endereço de site qual número correspondente de nSiteAutoriz o contribuinte pode usar.","maximum":9,"minimum":0,"x-nullable":true},"cMunFG":{"type":"string","description":"Código do município de ocorrência do fato gerador.","x-nullable":true},"finNFCom":{"type":"integer","description":"Finalidade de emissão da NFCom.\r\n* 0 - NFCom Normal\r\n* 3 - NFCom de Substituição\r\n* 4 - NFCom de Ajuste","x-nullable":true},"tpFat":{"type":"integer","description":"Tipo de Faturamento da NFCom.\r\n* 0 - Faturamento Normal\r\n* 1 - Faturamento centralizado\r\n* 2 - Cofaturamento","x-nullable":true},"verProc":{"type":"string","description":"Versão do processo de emissão.\r\nInformar a versão do aplicativo emissor de NFCom.","maxLength":20,"minLength":1,"x-nullable":true},"indPrePago":{"type":"integer","description":"Indicador de serviço pré-pago.\r\n* 1 - Serviço pré-pago (informar a tag somente se a nota for referente a um serviço exclusivamente pré-pago)","x-nullable":true},"indCessaoMeiosRede":{"type":"integer","description":"Indicador de Sessão de Meios de Rede.\r\nUma vez informado (valor = 1), essa tag dispensa geração do grupo Fatura.\r\nApenas para notas dos tipos Normal e Substituição com tipo de faturamento normal.","x-nullable":true},"indNotaEntrada":{"type":"integer","description":"Indicador de nota de entrada.\r\n* 1 - Informar quando for nota de ajuste e possuir itens com CFOP de entrada","x-nullable":true},"dhCont":{"type":"string","format":"date-time","description":"Data e Hora da entrada em contingência.\r\nInformar a data e hora no formato AAAA-MM-DDTHH:MM:SS.","x-nullable":true},"xJust":{"type":"string","description":"Justificativa da entrada em contingência.","maxLength":256,"minLength":15,"x-nullable":true},"gCompraGov":{"$ref":"#/definitions/NfcomSefazCompraGovReduzido"}},"required":["verProc","tpFat","finNFCom","cMunFG","nSiteAutoriz","tpEmis","dhEmi","nNF","serie","cUF"]},"NfcomSefazCompraGovReduzido":{"type":"object","description":"Grupo de Compras Governamentais.","properties":{"tpEnteGov":{"type":"integer","description":"Para administração pública direta e suas autarquias e fundações:\r\n* 1 - União\r\n* 2 - Estados\r\n* 3 - Distrito Federal\r\n* 4 - Municípios","x-nullable":true},"pRedutor":{"type":"number","description":"Percentual de redução de aliquota em compra governamental.","minimum":0,"x-nullable":true}},"required":["pRedutor","tpEnteGov"]},"NfcomSefazEmit":{"type":"object","description":"Identificação do Emitente do documento fiscal.","properties":{"CNPJ":{"type":"string","description":"CNPJ do emitente.\r\nInformar zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"IEUFDest":{"type":"string","description":"Inscrição Estadual Virtual do emitente na UF de Destino da partilha (IE Virtual).","x-nullable":true},"CRT":{"type":"integer","description":"Código do Regime Tributário. Informar:\r\n* 1 - Simples Nacional;\r\n* 2 - Simples Nacional, excesso sublimite de receita bruta;\r\n* 3 - Regime Normal.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou Nome do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"enderEmit":{"$ref":"#/definitions/NfcomSefazEndeEmi"}},"required":["CNPJ"]},"NfcomSefazEndeEmi":{"type":"object","description":"Endereço do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","properties":{"xLgr":{"type":"string","description":"Logradouro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"fone":{"type":"string","description":"Telefone.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"email":{"type":"string","description":"Endereço de E-mail.","maxLength":60,"minLength":1,"x-nullable":true}}},"NfcomSefazDest":{"type":"object","description":"Identificação do destinatário / assinante.","properties":{"xNome":{"type":"string","description":"Razão social ou Nome do destinatário.","maxLength":60,"minLength":2,"x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"idOutros":{"type":"string","description":"Identificação do destinatário outros.\r\nIdentificação do destinatário não obrigado a inscrição do CPF tais como estrangeiro, indígena e quilombola\r\nEm caso de não contar CPF do assinante, informar o RG.","maxLength":20,"minLength":2,"x-nullable":true},"indIEDest":{"type":"integer","description":"Indicador da IE do Destinatário.\r\n* 1 - Contribuinte ICMS (informar a IE do destinatário)\r\n* 2 - Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS\r\n* 9 - Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS\r\nNota: No caso de Contribuinte Isento de Inscrição (indIEDest=2) informar a tag IE do destinatário com o literal ISENTO.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual do destinatário.","x-nullable":true},"IM":{"type":"string","description":"Inscrição Municipal.","maxLength":15,"minLength":1,"x-nullable":true},"enderDest":{"$ref":"#/definitions/NfcomSefazEndeDest"}},"required":["enderDest","indIEDest","xNome"]},"NfcomSefazEndeDest":{"type":"object","description":"Endereço do destinatário / assinante.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.","x-nullable":true},"cPais":{"type":"string","description":"Código do país.\r\nUtilizar a tabela do BACEN.","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"email":{"type":"string","description":"Endereço de E-mail.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["UF","CEP","xMun","cMun","xBairro","nro","xLgr"]},"NfcomSefazAssinante":{"type":"object","description":"Dados do assinante.","properties":{"iCodAssinante":{"type":"string","description":"Código único de Identificação do assinante.","maxLength":30,"minLength":1,"x-nullable":true},"tpAssinante":{"type":"integer","description":"Tipo de assinante.\r\n* 1 - Comercial\r\n* 2 - Industrial\r\n* 3 - Residencial/Pessoa Física\r\n* 4 - Produtor Rural\r\n* 5 - Órgão da administração pública estadual direta e suas fundações e autarquias, quando mantidas pelo poder público estadual e regidas por normas de direito público, nos termos do Convênio ICMS 107/95\r\n* 6 - Prestador de serviço de telecomunicação responsável pelo recolhimento do imposto incidente sobre a cessão dos meios de rede do prestador do serviço ao usuário final, nos termos do Convênio ICMS 17/13\r\n* 7 - Missões Diplomáticas, Repartições Consulares e Organismos Internacionais, nos termos do Convênio ICMS 158/94\r\n* 8 - Igrejas e Templos de qualquer natureza\r\n* 99 - Outros não especificados anteriormente","x-nullable":true},"tpServUtil":{"type":"integer","description":"Tipo de serviço utilizado.\r\n* 1 - Telefonia\r\n* 2 - Comunicação de dados\r\n* 3 - TV por Assinatura\r\n* 4 - Provimento de acesso à Internet\r\n* 5 - Multimídia\r\n* 6 - Outros\r\n* 7 - Varios","x-nullable":true},"nContrato":{"type":"string","description":"Número do Contrato do assinante.","maxLength":20,"minLength":1,"x-nullable":true},"dContratoIni":{"type":"string","format":"date","description":"Data de início do contrato.\r\nFormato AAAA-MM-DD.","x-nullable":true},"dContratoFim":{"type":"string","format":"date","description":"Data de término do contrato.\r\nFormato AAAA-MM-DD.","x-nullable":true},"NroTermPrinc":{"type":"string","description":"Número do Terminal Principal do serviço contratado.\r\nEm se tratando de plano de prestação de serviço telefônico corporativo, familiar ou similares, informar o número do terminal telefônico principal do plano.","x-nullable":true},"cUFPrinc":{"type":"integer","description":"Código da UF de habilitação do terminal.\r\nUtilizar a\r\nTabela do IBGE de código de unidades da federação.","x-nullable":true},"NroTermAdic":{"type":"string","description":"Número dos Terminais adicionais do serviço contratado.","x-nullable":true},"cUFAdic":{"type":"integer","description":"Código da UF de habilitação do terminal.","x-nullable":true}},"required":["tpServUtil","tpAssinante","iCodAssinante"]},"NfcomSefazGSub":{"type":"object","description":"Grupo de informações da substituição.","properties":{"chNFCom":{"type":"string","description":"Chave de acesso da NFCom original.","maxLength":44,"x-nullable":true},"gNF":{"$ref":"#/definitions/NfcomSefazGNF"},"motSub":{"type":"string","description":"Motivo da substituição.\r\n* 01 - Erro de Preço\r\n* 02 - Erro Cadastral\r\n* 03 - Decisão Judicial\r\n* 04 - Erro de Tributação\r\n* 05 - Descontinuidade do Serviço","maxLength":2,"minLength":2,"x-nullable":true}},"required":["motSub"]},"NfcomSefazGNF":{"type":"object","description":"Informação da NF modelo 21/22 referenciada.","properties":{"CNPJ":{"type":"string","description":"CNPJ do Emitente.\r\nInformar o CNPJ do emitente do Documento Fiscal.","x-nullable":true},"mod":{"type":"integer","description":"Modelo do documento.\r\n21 ou 22.","x-nullable":true},"serie":{"type":"string","description":"Serie do documento fiscal.","maxLength":3,"minLength":3,"x-nullable":true},"nNF":{"type":"integer","description":"Número do documento fiscal.","maximum":999999999,"minimum":1,"x-nullable":true},"CompetEmis":{"type":"string","description":"Ano e mês da emissão da NF (AAAAMM).","maxLength":6,"minLength":6,"x-nullable":true},"hash115":{"type":"string","description":"Hash do registro no arquivo do convênio 115.\r\nCampo poderá ser exigido a critério da UF - campo 36 do arquivo MESTRE DE DOCUMENTO FISCAL (Anexo Único, item 5 do Conv. 115/03).","x-nullable":true}},"required":["CompetEmis","nNF","serie","mod","CNPJ"]},"NfcomSefazGCofat":{"type":"object","description":"Grupo de Informações do Cofaturamento.","properties":{"chNFComLocal":{"type":"string","description":"Chave de acesso da NFCom emitida pela Operadora Local.","maxLength":44,"x-nullable":true},"gNF":{"$ref":"#/definitions/NfcomSefazGCofat_GNF"}}},"NfcomSefazGCofat_GNF":{"type":"object","description":"Informação da NF modelo 21/22 referenciada.","properties":{"CNPJ":{"type":"string","description":"CNPJ do Emitente.\r\nInformar o CNPJ do emitente do Documento Fiscal.","x-nullable":true},"mod":{"type":"integer","description":"Modelo do documento.\r\n21 ou 22.","x-nullable":true},"serie":{"type":"string","description":"Serie do documento fiscal.","maxLength":3,"minLength":3,"x-nullable":true},"nNF":{"type":"integer","description":"Número do documento fiscal.","maximum":999999999,"minimum":1,"x-nullable":true},"CompetEmis":{"type":"string","description":"Ano e mês da emissão da NF (AAAAMM).","maxLength":6,"minLength":6,"x-nullable":true},"hash115":{"type":"string","description":"Hash do registro no arquivo do convênio 115.\r\nCampo poderá ser exigido a critério da UF - campo 36 do arquivo MESTRE DE DOCUMENTO FISCAL (Anexo Único, item 5 do Conv. 115/03).","x-nullable":true}},"required":["CompetEmis","nNF","serie","mod","CNPJ"]},"NfcomSefazDet":{"type":"object","description":"Detalhamento de Produtos e Serviços.","properties":{"nItem":{"type":"integer","description":"Número do item da NFCom.","maximum":9999,"minimum":1,"x-nullable":true},"chNFComAnt":{"type":"string","description":"Chave de Acesso da NFCom anterior.\r\nInformar chave de acesso de referencia anterior\r\nTAG OPCIONAL, DEVE SER INFORMADA APENAS NOS CASOS PREVISTOS DE NOTA ANTERIOR REFERENCIADA.","maxLength":44,"x-nullable":true},"nItemAnt":{"type":"string","description":"Número do item da NFCom anterior.\r\nInformar nro do item da chave de acesso de referencia anterior\r\nTAG OPCIONAL, DEVE SER INFORMADA APENAS NOS CASOS PREVISTOS DE NOTA ANTERIOR REFERENCIADA.","x-nullable":true},"indNFComAntPapelFatCentral":{"type":"integer","description":"Indicador de Nota anterior em papel no faturamento centralizado.\r\nInforma que a NFCom Anterior de Faturamento centralizado não é eletrônica.","x-nullable":true},"prod":{"$ref":"#/definitions/NfcomSefazProd"},"imposto":{"$ref":"#/definitions/NfcomSefazImposto"},"gProcRef":{"$ref":"#/definitions/NfcomSefazGProcRef"},"gRessarc":{"$ref":"#/definitions/NfcomSefazGRessarc"},"infAdProd":{"type":"string","description":"Informações adicionais do produto (norma referenciada, informações complementares, etc).","maxLength":500,"minLength":1,"x-nullable":true}},"required":["imposto","prod","nItem"]},"NfcomSefazProd":{"type":"object","description":"Dados do Produto ou Serviço.","properties":{"cProd":{"type":"string","description":"Código do produto ou serviço.","maxLength":60,"minLength":1,"x-nullable":true},"xProd":{"type":"string","description":"Descrição do produto ou serviço.","maxLength":120,"minLength":1,"x-nullable":true},"cClass":{"type":"string","description":"Código de classificação.\r\nTabela de Classificação de Item da NFCom (validar por RV).","maxLength":7,"minLength":7,"x-nullable":true},"CFOP":{"type":"string","description":"CFOP.\r\nUtilizar Tabela de CFOP.","x-nullable":true},"CNPJLD":{"type":"string","description":"CNPJ da operadora LD.\r\nInformar o CNPJ da operadora LD que irá lançar o item de cofaturamento em nota do tipo faturamento 2.","x-nullable":true},"uMed":{"type":"integer","description":"Unidade Básica de Medida.\r\n* 1 - Minuto\r\n* 2 - MB\r\n* 3 - GB\r\n* 4 - UN","x-nullable":true},"qFaturada":{"type":"number","description":"Quantidade Faturada.\r\nInformar a quantidade de comercialização do produto .","minimum":0,"x-nullable":true},"vItem":{"type":"number","description":"Valor unitário do item.","minimum":0,"x-nullable":true},"vDesc":{"type":"number","description":"Valor do Desconto.","minimum":0,"x-nullable":true},"vOutro":{"type":"number","description":"Outras despesas acessórias.","minimum":0,"x-nullable":true},"vProd":{"type":"number","description":"Valor total do item.","minimum":0,"x-nullable":true},"dExpiracao":{"type":"string","format":"date","description":"Data de expiração de crédito.\r\nFormato AAAA-MM-DD.","x-nullable":true},"indDevolucao":{"type":"integer","description":"Indicador de devolução do valor do item.\r\n* 1 - Devolução do valor do item","x-nullable":true}},"required":["vProd","vItem","qFaturada","uMed","cClass","xProd","cProd"]},"NfcomSefazImposto":{"type":"object","description":"Tributos incidentes no Produto ou Serviço.","properties":{"ICMS00":{"$ref":"#/definitions/NfcomSefazICMS00"},"ICMS20":{"$ref":"#/definitions/NfcomSefazICMS20"},"ICMS40":{"$ref":"#/definitions/NfcomSefazICMS40"},"ICMS51":{"$ref":"#/definitions/NfcomSefazICMS51"},"ICMS90":{"$ref":"#/definitions/NfcomSefazICMS90"},"ICMSSN":{"$ref":"#/definitions/NfcomSefazICMSSN"},"ICMSUFDest":{"type":"array","items":{"$ref":"#/definitions/NfcomSefazICMSUFDest"}},"indSemCST":{"type":"integer","description":"Sem Situação Tributária para o ICMS.\r\nInformar para itens que não tenham nenhuma relação com o ICMS.\r\nQuando informado o item NÃO PODE ter CFOP informado\r\nSe informado esse grupo o schema não permite informar nenhum dos grupos de ICMSXX.","x-nullable":true},"PIS":{"$ref":"#/definitions/NfcomSefazPIS"},"COFINS":{"$ref":"#/definitions/NfcomSefazCOFINS"},"FUST":{"$ref":"#/definitions/NfcomSefazFUST"},"FUNTTEL":{"$ref":"#/definitions/NfcomSefazFUNTTEL"},"retTrib":{"$ref":"#/definitions/NfcomSefazRetTrib"},"IBSCBS":{"$ref":"#/definitions/NfcomSefazTribNFCom"}}},"NfcomSefazICMS00":{"type":"object","description":"Prestação sujeito à tributação normal do ICMS.\r\nTributada integralmente.","properties":{"CST":{"type":"string","description":"classificação Tributária do Serviço.\r\n* 00 - tributação normal ICMS","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true}},"required":["vICMS","pICMS","vBC","CST"]},"NfcomSefazICMS20":{"type":"object","description":"Prestação sujeito à tributação com redução de BC do ICMS.","properties":{"CST":{"type":"string","description":"Classificação Tributária do serviço.\r\n* 20 - tributação com BC reduzida do ICMS","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF aplicado ao item.\r\nCódigo de Benefício Fiscal utilizado pela UF, aplicado ao\r\nitem.","maxLength":10,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true}},"required":["vICMS","pICMS","vBC","pRedBC","CST"]},"NfcomSefazICMS40":{"type":"object","description":"Tributação Isenta, Não tributada.","properties":{"CST":{"type":"string","description":"Classificação Tributária do serviço.\r\n* 40 - Isenta\r\n* 41 - Não tributada","x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF aplicado ao item.\r\nCódigo de Benefício Fiscal utilizado pela UF, aplicado ao\r\nitem.","maxLength":10,"x-nullable":true}},"required":["CST"]},"NfcomSefazICMS51":{"type":"object","description":"Tributação com Diferimento.\r\nA exigência do preenchimento das informações do ICMS diferido fica a critério de cada UF.","properties":{"CST":{"type":"string","description":"Classificação Tributária do serviço.\r\nTributação pelo ICMS 51 - Diferimento.","x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF aplicado ao item.\r\nCódigo de Benefício Fiscal utilizado pela UF, aplicado ao\r\nitem.","maxLength":10,"x-nullable":true}},"required":["CST"]},"NfcomSefazICMS90":{"type":"object","description":"ICMS Outros.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS outros","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF aplicado ao item.\r\nCódigo de Benefício Fiscal utilizado pela UF, aplicado ao\r\nitem.","maxLength":10,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true}},"required":["CST"]},"NfcomSefazICMSSN":{"type":"object","description":"Simples Nacional.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - Outros SN","x-nullable":true},"indSN":{"type":"integer","description":"Indica se o contribuinte é Simples Nacional\t\t\t1=Sim.","x-nullable":true}},"required":["indSN","CST"]},"NfcomSefazICMSUFDest":{"type":"object","description":"Informações do ICMS de partilha com a UF destinatária.","properties":{"cUFDest":{"type":"integer","x-nullable":true},"vBCUFDest":{"type":"number","description":"Valor da BC do ICMS na UF de destino.","minimum":0,"x-nullable":true},"pFCPUFDest":{"type":"number","description":"Percentual do ICMS relativo ao Fundo de Combate à pobreza (FCP) na UF de destino.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"pICMSUFDest":{"type":"number","description":"Alíquota interna da UF de destino.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"vFCPUFDest":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate á Pobreza (FCP) da UF de destino.","minimum":0,"x-nullable":true},"vICMSUFDest":{"type":"number","description":"Valor do ICMS de partilha para a UF de destino.","minimum":0,"x-nullable":true},"vICMSUFEmi":{"type":"number","description":"Valor do ICMS de partilha para a UF de emissão.","minimum":0,"x-nullable":true},"cBenefUFDest":{"type":"string","description":"Código de Benefício Fiscal na UF destino aplicado ao item.\r\nCódigo de Benefício Fiscal utilizado pela UF, aplicado ao\r\nitem.","maxLength":10,"x-nullable":true}},"required":["vICMSUFEmi","vICMSUFDest","vFCPUFDest","pICMSUFDest","pFCPUFDest","vBCUFDest"]},"NfcomSefazPIS":{"type":"object","description":"Dados do PIS.","properties":{"CST":{"type":"string","description":"classificação Tributária do PIS.\r\n* 01 - Tributável com alíquota básica\r\n* 02 - Tributável com alíquota diferenciada\r\n* 06 - Tributável com alíquota zero\r\n* 07 - Operação isenta de contribuição\r\n* 08 - Operação sem incidência da contribuição\r\n* 09 - Operação com suspensão da contribuição\r\n* 49 - Outras operações de saída","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do PIS.","minimum":0,"x-nullable":true},"pPIS":{"type":"number","description":"Alíquota do PIS (em percentual).","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true}},"required":["vPIS","pPIS","vBC","CST"]},"NfcomSefazCOFINS":{"type":"object","description":"Dados do COFINS.","properties":{"CST":{"type":"string","description":"classificação Tributária do COFINS.\r\n* 01 - Tributável com alíquota básica\r\n* 02 - Tributável com alíquota diferenciada\r\n* 06 - Tributável com alíquota zero\r\n* 07 - Operação isenta de contribuição\r\n* 08 - Operação sem incidência da contribuição\r\n* 09 - Operação com suspensão da contribuição\r\n* 49 - Outras operações de saída","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do COFINS.","minimum":0,"x-nullable":true},"pCOFINS":{"type":"number","description":"Alíquota do COFINS (em percentual).","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS.","minimum":0,"x-nullable":true}},"required":["vCOFINS","pCOFINS","vBC","CST"]},"NfcomSefazFUST":{"type":"object","description":"Dados do FUST.","properties":{"vBC":{"type":"number","description":"Valor da BC do FUST.","minimum":0,"x-nullable":true},"pFUST":{"type":"number","description":"Alíquota do FUST (em percentual).","minimum":0,"x-nullable":true},"vFUST":{"type":"number","description":"Valor do FUST.","minimum":0,"x-nullable":true}},"required":["vFUST","pFUST","vBC"]},"NfcomSefazFUNTTEL":{"type":"object","description":"Dados do FUNTTEL.","properties":{"vBC":{"type":"number","description":"Valor da BC do FUNTTEL.","minimum":0,"x-nullable":true},"pFUNTTEL":{"type":"number","description":"Alíquota do FUNTTEL (em percentual).","minimum":0,"x-nullable":true},"vFUNTTEL":{"type":"number","description":"Valor do FUNTEL.","minimum":0,"x-nullable":true}},"required":["vFUNTTEL","pFUNTTEL","vBC"]},"NfcomSefazRetTrib":{"type":"object","description":"Grupo de informações de retenção de tributos federais.","properties":{"vRetPIS":{"type":"number","description":"Valor do PIS retido.","minimum":0,"x-nullable":true},"vRetCofins":{"type":"number","description":"Valor do COFNS retido.","minimum":0,"x-nullable":true},"vRetCSLL":{"type":"number","description":"Valor da CSLL retida.","minimum":0,"x-nullable":true},"vBCIRRF":{"type":"number","description":"Base de cálculo do IRRF.","minimum":0,"x-nullable":true},"vIRRF":{"type":"number","description":"Valor do IRRF retido.","minimum":0,"x-nullable":true}},"required":["vIRRF","vBCIRRF","vRetCSLL","vRetCofins","vRetPIS"]},"NfcomSefazTribNFCom":{"type":"object","description":"Grupo de informações do IBS e CBS.","properties":{"CST":{"type":"string","description":"Código Situação Tributária do IBS/CBS.","x-nullable":true},"cClassTrib":{"type":"string","x-nullable":true},"indDoacao":{"type":"integer","description":"Indica se a operação é de doação.","x-nullable":true},"gIBSCBS":{"$ref":"#/definitions/NfcomSefazCIBS"},"gEstornoCred":{"$ref":"#/definitions/NfcomSefazEstornoCred"}},"required":["CST"]},"NfcomSefazCIBS":{"type":"object","properties":{"vBC":{"type":"number","description":"Valor do BC.","minimum":0,"x-nullable":true},"gIBSUF":{"$ref":"#/definitions/NfcomSefazGIBSUF"},"gIBSMun":{"$ref":"#/definitions/NfcomSefazGIBSMun"},"vIBS":{"type":"number","description":"Valor do IBS.","minimum":0,"x-nullable":true},"gCBS":{"$ref":"#/definitions/NfcomSefazGCBS"},"gTribRegular":{"$ref":"#/definitions/NfcomSefazTribRegular"},"gTribCompraGov":{"$ref":"#/definitions/NfcomSefazTribCompraGov"}},"required":["gCBS","vIBS","gIBSMun","gIBSUF","vBC"]},"NfcomSefazGIBSUF":{"type":"object","description":"Grupo de informações do IBS na UF.","properties":{"pIBSUF":{"type":"number","description":"Aliquota do IBS de competência das UF (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/NfcomSefazDif"},"gDevTrib":{"$ref":"#/definitions/NfcomSefazDevTrib"},"gRed":{"$ref":"#/definitions/NfcomSefazRed"},"vIBSUF":{"type":"number","description":"Valor do IBS de competência das UF.","minimum":0,"x-nullable":true}},"required":["vIBSUF","pIBSUF"]},"NfcomSefazDif":{"type":"object","description":"Grupo de campos do Diferimento.","properties":{"pDif":{"type":"number","description":"Percentual do diferimento.","minimum":0,"x-nullable":true},"vDif":{"type":"number","description":"Valor do diferimento.","minimum":0,"x-nullable":true}},"required":["vDif","pDif"]},"NfcomSefazDevTrib":{"type":"object","description":"Grupo de Informações da devolução de tributos.","properties":{"vDevTrib":{"type":"number","description":"Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e\r\ngás natural e em outras hipóteses definidas no regulamento.","minimum":0,"x-nullable":true}},"required":["vDevTrib"]},"NfcomSefazRed":{"type":"object","description":"Grupo de campos da redução de aliquota.","properties":{"pRedAliq":{"type":"number","description":"Percentual de redução de aliquota do cClassTrib.","minimum":0,"x-nullable":true},"pAliqEfet":{"type":"number","description":"Aliquota Efetiva que será aplicada a Base de Calculo (em percentual).","minimum":0,"x-nullable":true}},"required":["pAliqEfet","pRedAliq"]},"NfcomSefazGIBSMun":{"type":"object","description":"Grupo de Informações do IBS no Município.","properties":{"pIBSMun":{"type":"number","description":"Aliquota do IBS Municipal (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/NfcomSefazDif"},"gDevTrib":{"$ref":"#/definitions/NfcomSefazDevTrib"},"gRed":{"$ref":"#/definitions/NfcomSefazRed"},"vIBSMun":{"type":"number","description":"Valor do IBS Municipal.","minimum":0,"x-nullable":true}},"required":["vIBSMun","pIBSMun"]},"NfcomSefazGCBS":{"type":"object","description":"Grupo de Tributação da CBS.","properties":{"pCBS":{"type":"number","description":"Aliquota da CBS (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/NfcomSefazDif"},"gDevTrib":{"$ref":"#/definitions/NfcomSefazDevTrib"},"gRed":{"$ref":"#/definitions/NfcomSefazRed"},"vCBS":{"type":"number","description":"Valor da CBS.","minimum":0,"x-nullable":true}},"required":["vCBS","pCBS"]},"NfcomSefazTribRegular":{"type":"object","description":"Grupo de informações da Tributação Regular. Informar como seria a tributação caso não cumprida a condição resolutória/suspensiva. Exemplo 1: Art. 442, §4. Operações com ZFM e ALC. Exemplo 2: Operações com suspensão do tributo.","properties":{"CSTReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS.\r\nInformar qual seria o CST caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"cClassTribReg":{"type":"string","description":"Informar qual seria o cClassTrib caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"pAliqEfetRegIBSUF":{"type":"number","description":"Alíquota do IBS da UF.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSUF":{"type":"number","description":"Valor do IBS da UF.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegIBSMun":{"type":"number","description":"Alíquota do IBS do Município.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSMun":{"type":"number","description":"Valor do IBS do Município.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegCBS":{"type":"number","description":"Alíquota da CBS.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegCBS":{"type":"number","description":"Valor da CBS.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true}},"required":["vTribRegCBS","pAliqEfetRegCBS","vTribRegIBSMun","pAliqEfetRegIBSMun","vTribRegIBSUF","pAliqEfetRegIBSUF","cClassTribReg","CSTReg"]},"NfcomSefazTribCompraGov":{"type":"object","description":"Grupo de informações da composição do valor do IBS e da CBS em compras governamental.","properties":{"pAliqIBSUF":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSUF":{"type":"number","description":"Valor que seria devido a UF, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqIBSMun":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSMun":{"type":"number","description":"Valor que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqCBS":{"type":"number","minimum":0,"x-nullable":true},"vTribCBS":{"type":"number","description":"Valor que seria devido a CBS, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true}},"required":["vTribCBS","vTribIBSMun","vTribIBSUF"]},"NfcomSefazEstornoCred":{"type":"object","description":"Informado conforme indicador no cClassTrib.","properties":{"vIBSEstCred":{"type":"number","description":"Valor do IBS a ser estornado.","minimum":0,"x-nullable":true},"vCBSEstCred":{"type":"number","description":"Valor da CBS a ser estornada.","minimum":0,"x-nullable":true}},"required":["vCBSEstCred","vIBSEstCred"]},"NfcomSefazGProcRef":{"type":"object","description":"Grupo Processo referenciado.\r\nEste grupo somente deverá ser preenchido quando houver processo judicial ou administrativo que altere valores.","properties":{"vItem":{"type":"number","description":"Valor unitário do item.\r\nInformar o valor sem a influência da decisão judicial/administrativa.","minimum":0,"x-nullable":true},"qFaturada":{"type":"number","description":"Quantidade Faturada.\r\nInformar a quantidade de comercialização do produto .","minimum":0,"x-nullable":true},"vProd":{"type":"number","description":"Valor total do item.","minimum":0,"x-nullable":true},"vDesc":{"type":"number","description":"Valor do Desconto.","minimum":0,"x-nullable":true},"vOutro":{"type":"number","description":"Outras despesas acessórias.","minimum":0,"x-nullable":true},"indDevolucao":{"type":"integer","description":"Indicador de devolução do valor do item.\r\n* 1 - Devolução do valor do item","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS.","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"gProc":{"type":"array","items":{"$ref":"#/definitions/NfcomSefazGProc"},"maxItems":10,"minItems":1}},"required":["gProc","vProd","qFaturada","vItem"]},"NfcomSefazGProc":{"type":"object","description":"Grupo identificador do Processo.","properties":{"tpProc":{"type":"integer","description":"Tipo de Processo.\r\n* 0 - SEFAZ\r\n* 1 - Justiça Federal\r\n* 2 - Justiça Estadual","x-nullable":true},"nProcesso":{"type":"string","description":"Número do Processo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["nProcesso","tpProc"]},"NfcomSefazGRessarc":{"type":"object","description":"Grupo de Informações detalhadas de item de cClass de Ressarcimento.","properties":{"tpRessarc":{"type":"integer","description":"Tipo de Ressarcimento.\r\n* 1 - Cobrança Indevida\r\n* 2 - Interrupção\r\n* 99 - Outros","x-nullable":true},"dRef":{"type":"string","format":"date","description":"Data de referencia.\r\nFormato AAAA-MM-DD.","x-nullable":true},"nProcesso":{"type":"string","description":"Número do Processo.","maxLength":60,"minLength":1,"x-nullable":true},"nProtReclama":{"type":"string","description":"Número do protocolo de reclamação.","maxLength":60,"minLength":1,"x-nullable":true},"xObs":{"type":"string","description":"Observações sobre o processo de ressarcimento.","maxLength":100,"minLength":15,"x-nullable":true}},"required":["dRef","tpRessarc"]},"NfcomSefazTotal":{"type":"object","description":"Dados dos totais da NFCom.","properties":{"vProd":{"type":"number","description":"Valor Total dos produtos e serviços.","minimum":0,"x-nullable":true},"ICMSTot":{"$ref":"#/definitions/NfcomSefazICMSTot"},"vCOFINS":{"type":"number","description":"Valor do COFINS.","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true},"vFUNTTEL":{"type":"number","description":"Valor do FUNTTEL.","minimum":0,"x-nullable":true},"vFUST":{"type":"number","description":"Valor do FUST.","minimum":0,"x-nullable":true},"vRetTribTot":{"$ref":"#/definitions/NfcomSefazVRetTribTot"},"vDesc":{"type":"number","description":"Valor Total do Desconto.","minimum":0,"x-nullable":true},"vOutro":{"type":"number","description":"Outras Despesas acessórias.","minimum":0,"x-nullable":true},"vNF":{"type":"number","description":"Valor Total da NFCom.","minimum":0,"x-nullable":true},"IBSCBSTot":{"$ref":"#/definitions/NfcomSefazIBSCBSTot"},"vTotDFe":{"type":"number","description":"Valor total do documento fiscal\r\n(vNF + total do IBS + total da CBS).","minimum":0,"x-nullable":true}},"required":["vNF","vOutro","vDesc","vRetTribTot","vFUST","vFUNTTEL","vPIS","vCOFINS","ICMSTot","vProd"]},"NfcomSefazICMSTot":{"type":"object","description":"Totais referentes ao ICMS.","properties":{"vBC":{"type":"number","description":"BC do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor Total do ICMS.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor Total do ICMS desonerado.","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor Total do FCP (Fundo de Combate à Pobreza).","minimum":0,"x-nullable":true}},"required":["vFCP","vICMSDeson","vICMS","vBC"]},"NfcomSefazVRetTribTot":{"type":"object","description":"Total da retenção de tributos federais.","properties":{"vRetPIS":{"type":"number","description":"Valor do PIS retido.","minimum":0,"x-nullable":true},"vRetCofins":{"type":"number","description":"Valor do COFNS retido.","minimum":0,"x-nullable":true},"vRetCSLL":{"type":"number","description":"Valor da CSLL retida.","minimum":0,"x-nullable":true},"vIRRF":{"type":"number","description":"Valor do IRRF retido.","minimum":0,"x-nullable":true}},"required":["vIRRF","vRetCSLL","vRetCofins","vRetPIS"]},"NfcomSefazIBSCBSTot":{"type":"object","description":"Totais de IBS e CBS.","properties":{"vBCIBSCBS":{"type":"number","description":"Total Base de Calculo.","minimum":0,"x-nullable":true},"gIBS":{"$ref":"#/definitions/NfcomSefazGIBS"},"gCBS":{"$ref":"#/definitions/NfcomSefazIBSCBSTot_GCBS"},"gEstornoCred":{"$ref":"#/definitions/NfcomSefazGEstornoCred"}},"required":["gCBS","gIBS","vBCIBSCBS"]},"NfcomSefazGIBS":{"type":"object","description":"Totalização do IBS.","properties":{"gIBSUF":{"$ref":"#/definitions/NfcomSefazGIBS_GIBSUF"},"gIBSMun":{"$ref":"#/definitions/NfcomSefazGIBS_GIBSMun"},"vIBS":{"type":"number","description":"Valor total do IBS.","minimum":0,"x-nullable":true}},"required":["vIBS","gIBSMun","gIBSUF"]},"NfcomSefazGIBS_GIBSUF":{"type":"object","description":"Totalização do IBS de competência da UF.","properties":{"vDif":{"type":"number","description":"Total do Diferimento.","minimum":0,"x-nullable":true},"vDevTrib":{"type":"number","description":"Total de devoluções de tributos.","minimum":0,"x-nullable":true},"vIBSUF":{"type":"number","description":"Valor total do IBS Estadual.","minimum":0,"x-nullable":true}},"required":["vIBSUF","vDevTrib","vDif"]},"NfcomSefazGIBS_GIBSMun":{"type":"object","description":"Totalização do IBS de competência Municipal.","properties":{"vDif":{"type":"number","description":"Total do Diferimento.","minimum":0,"x-nullable":true},"vDevTrib":{"type":"number","description":"Total de devoluções de tributos.","minimum":0,"x-nullable":true},"vIBSMun":{"type":"number","description":"Valor total do IBS Municipal.","minimum":0,"x-nullable":true}},"required":["vIBSMun","vDevTrib","vDif"]},"NfcomSefazIBSCBSTot_GCBS":{"type":"object","description":"Totalização da CBS.","properties":{"vDif":{"type":"number","description":"Total do Diferimento.","minimum":0,"x-nullable":true},"vDevTrib":{"type":"number","description":"Total de devoluções de tributos.","minimum":0,"x-nullable":true},"vCBS":{"type":"number","description":"Valor total da CBS.","minimum":0,"x-nullable":true}},"required":["vCBS","vDevTrib","vDif"]},"NfcomSefazGEstornoCred":{"type":"object","description":"Totalização do estorno de crédito.","properties":{"vIBSEstCred":{"type":"number","description":"Valor total do IBS estornado.","minimum":0,"x-nullable":true},"vCBSEstCred":{"type":"number","description":"Valor total da CBS estornada.","minimum":0,"x-nullable":true}},"required":["vCBSEstCred","vIBSEstCred"]},"NfcomSefazGFidelidade":{"type":"object","description":"Grupo de informações do programa de fidelidade do assinante.","properties":{"qtdSaldoPts":{"type":"string","description":"Saldo de pontos do cliente na  data de referência.","maxLength":20,"minLength":1,"x-nullable":true},"dRefSaldoPts":{"type":"string","format":"date","description":"Data de aferição do saldo de pontos.\r\nFormato AAAA-MM-DD.","x-nullable":true},"qtdPtsResg":{"type":"string","description":"Qtd de pontos resgatados na  data de referência.","maxLength":20,"minLength":1,"x-nullable":true},"dRefResgPts":{"type":"string","format":"date","description":"Data de resgate dos pontos.\r\nFormato AAAA-MM-DD.","x-nullable":true}},"required":["dRefResgPts","qtdPtsResg","dRefSaldoPts","qtdSaldoPts"]},"NfcomSefazGFat":{"type":"object","description":"Grupo de informações de controle da Fatura.","properties":{"CompetFat":{"type":"string","description":"Ano e mês referência do faturamento (AAAAMM).","maxLength":6,"minLength":6,"x-nullable":true},"dVencFat":{"type":"string","format":"date","description":"Data de vencimento da fatura.\r\nFormato AAAA-MM-DD.","x-nullable":true},"dPerUsoIni":{"type":"string","format":"date","description":"Período de uso inicial.\r\nFormato AAAA-MM-DD.","x-nullable":true},"dPerUsoFim":{"type":"string","format":"date","description":"Período de uso final.\r\nFormato AAAA-MM-DD.","x-nullable":true},"codBarras":{"type":"string","description":"Linha digitável do código de barras.","maxLength":48,"minLength":1,"x-nullable":true},"codDebAuto":{"type":"string","description":"Código de autorização débito em conta.","maxLength":20,"minLength":1,"x-nullable":true},"codBanco":{"type":"string","description":"Número do banco para débito em conta.","maxLength":5,"minLength":3,"x-nullable":true},"codAgencia":{"type":"string","description":"Número da agência bancária para débito em conta.","maxLength":10,"minLength":1,"x-nullable":true},"enderCorresp":{"$ref":"#/definitions/NfcomSefazEndeEmi"},"gPIX":{"$ref":"#/definitions/NfcomSefazGPIX"}},"required":["codBarras","dVencFat","CompetFat"]},"NfcomSefazGPIX":{"type":"object","description":"Grupo de informações do PIX.","properties":{"urlQRCodePIX":{"type":"string","description":"URL do QRCode do PIX que será apresentado na fatura.","maxLength":2000,"minLength":2,"x-nullable":true}},"required":["urlQRCodePIX"]},"NfcomSefazGFatCentral":{"type":"object","description":"Grupo de informações do Faturamento Centralizado.","properties":{"CNPJ":{"type":"string","description":"CNPJ do Emitente centralizador.\r\nInformar o CNPJ do emitente do Documento Fiscal.","x-nullable":true},"cUF":{"type":"integer","description":"Código da UF do emitente centralizador.\r\nCódigo da UF do emitente do Documento Fiscal. Utilizar a\r\nTabela do IBGE de código de unidades da federação.","x-nullable":true}},"required":["cUF","CNPJ"]},"NfcomSefazAutXML":{"type":"object","description":"Autorizados para download do XML do DF-e.\r\nInformar CNPJ ou CPF. Preencher os zeros não significativos.","properties":{"CNPJ":{"type":"string","description":"CNPJ do autorizado.\r\nInformar zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"CPF do autorizado.\r\nInformar zeros não significativos.","x-nullable":true}}},"NfcomSefazInfAdic":{"type":"object","description":"Informações Adicionais.","properties":{"infAdFisco":{"type":"string","description":"Informações adicionais de interesse do Fisco.\r\nNorma referenciada, informações complementares, etc.","maxLength":2000,"minLength":1,"x-nullable":true},"infCpl":{"type":"array","description":"Informações complementares de interesse do Contribuinte.","items":{"type":"string"},"maxItems":5}}},"NfcomSefazRespTec":{"type":"object","description":"Informações do Responsável Técnico pela emissão do DF-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ da pessoa jurídica responsável técnica pelo sistema utilizado na emissão do documento fiscal eletrônico.\r\nInformar o CNPJ da pessoa jurídica desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico.","x-nullable":true},"xContato":{"type":"string","description":"Nome da pessoa a ser contatada.\r\nInformar o nome da pessoa a ser contatada na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico. No caso de pessoa física, informar o respectivo nome.","maxLength":60,"minLength":2,"x-nullable":true},"email":{"type":"string","description":"Email da pessoa jurídica a ser contatada.","maxLength":60,"minLength":1,"x-nullable":true},"fone":{"type":"string","description":"Telefone da pessoa jurídica a ser contatada.\r\nPreencher com o Código DDD + número do telefone.","x-nullable":true},"idCSRT":{"type":"integer","description":"Identificador do código de segurança do responsável técnico.\r\nIdentificador do CSRT utilizado para geração do hash.","maximum":999,"minimum":0,"x-nullable":true},"CSRT":{"type":"string","description":"Código de Segurança do Responsável Técnico utilizado para montar o hash do CSRT.","x-nullable":true},"hashCSRT":{"type":"string","description":"Hash do token do código de segurança do responsável técnico.\r\nO hashCSRT é o resultado das funções SHA-1 e base64 do token CSRT fornecido pelo fisco + chave de acesso do DF-e. (Implementação em futura NT)\r\nObservação: 28 caracteres são representados no schema como 20 bytes do tipo base64Binary.\r\n\r\n*Se não informado, será calculado automaticamente, desde que os campos `idCSRT` e `CSRT` sejam fornecidos.*","maxLength":28,"x-nullable":true}},"required":["fone","email","xContato","CNPJ"]},"NfcomPedidoCancelamento":{"type":"object","properties":{"justificativa":{"type":"string","description":"Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco."}}},"ContaCota":{"type":"object","properties":{"nome":{"type":"string"},"consumo":{"type":"integer"},"limite":{"type":"integer"}}},"ContaCotaListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/ContaCota"}}}},"CtePedidoEmissao":{"type":"object","properties":{"infCte":{"$ref":"#/definitions/CteSefazInfCte"},"infCTeSupl":{"$ref":"#/definitions/CteSefazInfCTeSupl"},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true}},"required":["ambiente","infCte"]},"CteSefazInfCte":{"type":"object","description":"Informações do CT-e.","properties":{"versao":{"type":"string","description":"Versão do leiaute.\r\nEx: \"4.00\".","x-nullable":true},"Id":{"type":"string","description":"Identificador da tag a ser assinada.\r\nInformar a chave de acesso do CT-e e precedida do literal \"CTe\".\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"ide":{"$ref":"#/definitions/CteSefazIde"},"compl":{"$ref":"#/definitions/CteSefazCompl"},"emit":{"$ref":"#/definitions/CteSefazEmit"},"rem":{"$ref":"#/definitions/CteSefazRem"},"exped":{"$ref":"#/definitions/CteSefazExped"},"receb":{"$ref":"#/definitions/CteSefazReceb"},"dest":{"$ref":"#/definitions/CteSefazDest"},"vPrest":{"$ref":"#/definitions/CteSefazVPrest"},"imp":{"$ref":"#/definitions/CteSefazInfCte_Imp"},"infCTeNorm":{"$ref":"#/definitions/CteSefazInfCTeNorm"},"infCteComp":{"type":"array","items":{"$ref":"#/definitions/CteSefazInfCteComp"},"maxItems":10},"autXML":{"type":"array","items":{"$ref":"#/definitions/CteSefazAutXML"},"maxItems":10},"infRespTec":{"$ref":"#/definitions/CteSefazRespTec"},"infSolicNFF":{"$ref":"#/definitions/CteSefazInfSolicNFF"}},"required":["imp","vPrest","emit","ide","versao"]},"CteSefazIde":{"type":"object","description":"Identificação do CT-e.","properties":{"cUF":{"type":"integer","description":"Código da UF do emitente do CT-e.\r\nUtilizar a Tabela do IBGE.","x-nullable":true},"cCT":{"type":"string","description":"Código numérico que compõe a Chave de Acesso.\r\nNúmero aleatório gerado pelo emitente para cada CT-e, com o objetivo de evitar acessos indevidos ao documento.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"CFOP":{"type":"string","description":"Código Fiscal de Operações e Prestações.","x-nullable":true},"natOp":{"type":"string","description":"Natureza da Operação.","maxLength":60,"minLength":1,"x-nullable":true},"mod":{"type":"integer","description":"Modelo do documento fiscal.\r\nUtilizar o código 57 para identificação do CT-e, emitido em substituição aos modelos de conhecimentos em papel.","x-nullable":true},"serie":{"type":"integer","description":"Série do CT-e.\r\nPreencher com \"0\" no caso de série única.","maximum":999,"minimum":0,"x-nullable":true},"nCT":{"type":"integer","description":"Número do CT-e.","maximum":999999999,"minimum":1,"x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e hora de emissão do CT-e.\r\nFormato AAAA-MM-DDTHH:MM:DD TZD.","x-nullable":true},"tpImp":{"type":"integer","description":"Formato de impressão do DACTE:\r\n* 1 - Retrato\r\n* 2 - Paisagem","x-nullable":true},"tpEmis":{"type":"integer","description":"Forma de emissão do CT-e.\r\nPreencher com:\r\n* 1 - Normal\r\n* 3 - Regime Especial NFF\r\n* 4 - EPEC pela SVC\r\n* 5 - Contingência FSDA\r\n* 7 - Autorização pela SVC-RS\r\n* 8 - Autorização pela SVC-SP","x-nullable":true},"cDV":{"type":"integer","description":"Digito Verificador da chave de acesso do CT-e.\r\nInformar o dígito  de controle da chave de acesso do CT-e, que deve ser calculado com a aplicação do algoritmo módulo 11 (base 2,9) da chave de acesso.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maximum":9,"minimum":0,"x-nullable":true},"tpAmb":{"type":"integer","description":"Tipo do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"tpCTe":{"type":"integer","description":"Tipo do CT-e.\r\nPreencher com:\r\n* 0 - CT-e Normal\r\n* 1 - CT-e de Complemento de Valores\r\n* 3 - CT-e de Substituição","x-nullable":true},"procEmi":{"type":"integer","description":"Identificador do processo de emissão do CT-e.\r\nPreencher com:\r\n* 0 - emissão de CT-e com aplicativo do contribuinte\r\n* 3 - emissão CT-e pelo contribuinte com aplicativo fornecido pelo SEBRAE","x-nullable":true},"verProc":{"type":"string","description":"Versão do processo de emissão.\r\nIinformar a versão do aplicativo emissor de CT-e.","maxLength":20,"minLength":1,"x-nullable":true},"indGlobalizado":{"type":"integer","description":"Indicador de CT-e Globalizado.\r\nInformar valor 1 quando for Globalizado e não informar a tag quando não tratar de CT-e Globalizado.","x-nullable":true},"cMunEnv":{"type":"string","description":"Código do Município de envio do CT-e (de onde o documento foi transmitido).\r\nUtilizar a tabela do IBGE. Informar 9999999 para as operações com o exterior.","x-nullable":true},"xMunEnv":{"type":"string","description":"Nome do Município de envio do CT-e (de onde o documento foi transmitido).\r\nInformar PAIS/Municipio para as operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UFEnv":{"type":"string","description":"Sigla da UF de envio do CT-e (de onde o documento foi transmitido).\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"modal":{"type":"string","description":"Modal. Preencher com:\r\n* 01 - Rodoviário\r\n* 02 - Aéreo\r\n* 03 - Aquaviário\r\n* 04 - Ferroviário\r\n* 05 - Dutoviário\r\n* 06 - Multimodal","x-nullable":true},"tpServ":{"type":"integer","description":"Tipo do Serviço.\r\nPreencher com:\r\n* 0 - Normal\r\n* 1 - Subcontratação\r\n* 2 - Redespacho\r\n* 3 - Redespacho Intermediário\r\n* 4 - Serviço Vinculado a Multimodal","x-nullable":true},"cMunIni":{"type":"string","description":"Código do Município de início da prestação.\r\nUtilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.","x-nullable":true},"xMunIni":{"type":"string","description":"Nome do Município do início da prestação.\r\nInformar 'EXTERIOR' para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UFIni":{"type":"string","description":"UF do início da prestação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"cMunFim":{"type":"string","description":"Código do Município de término da prestação.\r\nUtilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.","x-nullable":true},"xMunFim":{"type":"string","description":"Nome do Município do término da prestação.\r\nInformar 'EXTERIOR' para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UFFim":{"type":"string","description":"UF do término da prestação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"retira":{"type":"integer","description":"Indicador se o Recebedor retira no Aeroporto, Filial, Porto ou Estação de Destino? Preencher com:\r\n* 0 - Sim\r\n* 1 - Não","x-nullable":true},"xDetRetira":{"type":"string","description":"Detalhes do retira.","maxLength":160,"minLength":1,"x-nullable":true},"indIEToma":{"type":"integer","description":"Indicador do papel do tomador na prestação do serviço:\r\n* 1 - Contribuinte ICMS\r\n* 2 - Contribuinte isento de inscrição\r\n* 9 - Não Contribuinte\r\nAplica-se ao tomador que for indicado no toma3 ou toma4.","x-nullable":true},"toma3":{"$ref":"#/definitions/CteSefazToma3"},"toma4":{"$ref":"#/definitions/CteSefazToma4"},"dhCont":{"type":"string","format":"date-time","description":"Data e Hora da entrada em contingência.\r\nInformar a data e hora no formato AAAA-MM-DDTHH:MM:SS.","x-nullable":true},"xJust":{"type":"string","description":"Justificativa da entrada em contingência.","maxLength":256,"minLength":15,"x-nullable":true},"gCompraGov":{"$ref":"#/definitions/CteSefazCompraGovReduzido"}},"required":["indIEToma","retira","UFFim","xMunFim","cMunFim","UFIni","xMunIni","cMunIni","tpServ","modal","UFEnv","xMunEnv","cMunEnv","verProc","procEmi","tpCTe","tpEmis","tpImp","dhEmi","nCT","serie","natOp","CFOP","cUF"]},"CteSefazToma3":{"type":"object","description":"Indicador do \"papel\" do tomador do serviço no CT-e.","properties":{"toma":{"type":"integer","description":"Tomador do Serviço.\r\nPreencher com:\r\n* 0 - Remetente\r\n* 1 - Expedidor\r\n* 2 - Recebedor\r\n* 3 - Destinatário\r\nSerão utilizadas as informações contidas no respectivo grupo, conforme indicado pelo conteúdo deste campo.","x-nullable":true}},"required":["toma"]},"CteSefazToma4":{"type":"object","description":"Indicador do \"papel\" do tomador do serviço no CT-e.","properties":{"toma":{"type":"integer","description":"Tomador do Serviço.\r\nPreencher com:\r\n* 4 - Outros\r\nObs: Informar os dados cadastrais do tomador do serviço.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.\r\nInformar a IE do tomador ou ISENTO se tomador é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o tomador não seja contribuinte do ICMS não informar o conteúdo.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome.","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome Fantasia.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"enderToma":{"$ref":"#/definitions/CteSefazEndereco"},"email":{"type":"string","description":"Endereço de email.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["enderToma","xNome","toma"]},"CteSefazEndereco":{"type":"object","description":"Dados do endereço.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":255,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\nInformar 9999999 para operações com o exterior.","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\nInformar EXTERIOR para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar os zeros não significativos.","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true},"cPais":{"type":"string","description":"Código do país.\r\nUtilizar a tabela do BACEN.","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["UF","xMun","cMun","xBairro","nro","xLgr"]},"CteSefazCompraGovReduzido":{"type":"object","description":"Grupo de Compras Governamentais.","properties":{"tpEnteGov":{"type":"integer","description":"Para administração pública direta e suas autarquias e fundações:\r\n* 1 - União\r\n* 2 - Estados\r\n* 3 - Distrito Federal\r\n* 4 - Municípios","x-nullable":true},"pRedutor":{"type":"number","description":"Percentual de redução de aliquota em compra governamental.","minimum":0,"x-nullable":true}},"required":["pRedutor","tpEnteGov"]},"CteSefazCompl":{"type":"object","description":"Dados complementares do CT-e para fins operacionais ou comerciais.","properties":{"xCaracAd":{"type":"string","description":"Característica adicional do transporte.\r\nTexto livre:\r\nREENTREGA\r\nDEVOLUÇÃO\r\nREFATURAMENTO\r\netc.","maxLength":15,"minLength":1,"x-nullable":true},"xCaracSer":{"type":"string","description":"Característica adicional do serviço.\r\nTexto livre:\r\nENTREGA EXPRESSA\r\nLOGÍSTICA REVERSA\r\nCONVENCIONAL\r\nEMERGENCIAL\r\netc.","maxLength":30,"minLength":1,"x-nullable":true},"xEmi":{"type":"string","description":"Funcionário emissor do CTe.","maxLength":20,"minLength":1,"x-nullable":true},"fluxo":{"$ref":"#/definitions/CteSefazFluxo"},"Entrega":{"$ref":"#/definitions/CteSefazEntrega"},"origCalc":{"type":"string","description":"Município de origem para efeito de cálculo do frete.","maxLength":40,"minLength":2,"x-nullable":true},"destCalc":{"type":"string","description":"Município de destino para efeito de cálculo do frete.","maxLength":40,"minLength":2,"x-nullable":true},"xObs":{"type":"string","description":"Observações Gerais.","maxLength":2000,"minLength":1,"x-nullable":true},"ObsCont":{"type":"array","items":{"$ref":"#/definitions/CteSefazObsCont"},"maxItems":10},"ObsFisco":{"type":"array","items":{"$ref":"#/definitions/CteSefazObsFisco"},"maxItems":10}}},"CteSefazFluxo":{"type":"object","description":"Previsão do fluxo da carga.\r\nPreenchimento obrigatório para o modal aéreo.","properties":{"xOrig":{"type":"string","description":"Sigla ou código interno da Filial/Porto/Estação/ Aeroporto de Origem.\r\nObservações para o modal aéreo:\r\n* Preenchimento obrigatório para o modal aéreo.","maxLength":60,"minLength":1,"x-nullable":true},"pass":{"type":"array","items":{"$ref":"#/definitions/CteSefazPass"}},"xDest":{"type":"string","description":"Sigla ou código interno da Filial/Porto/Estação/Aeroporto de Destino.\r\nObservações para o modal aéreo:\r\n* Preenchimento obrigatório para o modal aéreo.","maxLength":60,"minLength":1,"x-nullable":true},"xRota":{"type":"string","description":"Código da Rota de Entrega.","maxLength":10,"minLength":1,"x-nullable":true}}},"CteSefazPass":{"type":"object","properties":{"xPass":{"type":"string","description":"Sigla ou código interno da Filial/Porto/Estação/Aeroporto de Passagem.\r\nObservação para o modal aéreo:\r\n* O código de três letras IATA, referente ao aeroporto de transferência, deverá ser incluído, quando for o caso. Quando não for possível,  utilizar a sigla OACI. Qualquer solicitação de itinerário deverá ser incluída.","maxLength":15,"minLength":1,"x-nullable":true}}},"CteSefazEntrega":{"type":"object","description":"Informações ref. a previsão de entrega.","properties":{"semData":{"$ref":"#/definitions/CteSefazSemData"},"comData":{"$ref":"#/definitions/CteSefazComData"},"noPeriodo":{"$ref":"#/definitions/CteSefazNoPeriodo"},"semHora":{"$ref":"#/definitions/CteSefazSemHora"},"comHora":{"$ref":"#/definitions/CteSefazComHora"},"noInter":{"$ref":"#/definitions/CteSefazNoInter"}}},"CteSefazSemData":{"type":"object","description":"Entrega sem data definida.\r\nEsta opção é proibida para o modal aéreo.","properties":{"tpPer":{"type":"integer","description":"Tipo de data/período programado para entrega.\r\n* 0 - Sem data definida","x-nullable":true}},"required":["tpPer"]},"CteSefazComData":{"type":"object","description":"Entrega com data definida.","properties":{"tpPer":{"type":"integer","description":"Tipo de data/período programado para entrega.\r\nPreencher com:\r\n* 1 - Na data\r\n* 2 - Até a data\r\n* 3 - A partir da data","x-nullable":true},"dProg":{"type":"string","format":"date","description":"Data programada.\r\nFormato AAAA-MM-DD.","x-nullable":true}},"required":["dProg","tpPer"]},"CteSefazNoPeriodo":{"type":"object","description":"Entrega no período definido.","properties":{"tpPer":{"type":"integer","description":"Tipo período.\r\n* 4 - no período","x-nullable":true},"dIni":{"type":"string","format":"date","description":"Data inicial.\r\nFormato AAAA-MM-DD.","x-nullable":true},"dFim":{"type":"string","format":"date","description":"Data final.\r\nFormato AAAA-MM-DD.","x-nullable":true}},"required":["dFim","dIni","tpPer"]},"CteSefazSemHora":{"type":"object","description":"Entrega sem hora definida.","properties":{"tpHor":{"type":"integer","description":"Tipo de hora.\r\n* 0 - Sem hora definida","x-nullable":true}},"required":["tpHor"]},"CteSefazComHora":{"type":"object","description":"Entrega com hora definida.","properties":{"tpHor":{"type":"integer","description":"Tipo de hora.\r\nPreencher com:\r\n* 1 - No horário\r\n* 2 - Até o horário\r\n* 3 - A partir do horário","x-nullable":true},"hProg":{"type":"string","description":"Hora programada.\r\nFormato HH:MM:SS.","x-nullable":true}},"required":["hProg","tpHor"]},"CteSefazNoInter":{"type":"object","description":"Entrega no intervalo de horário definido.","properties":{"tpHor":{"type":"integer","description":"Tipo de hora.\r\n* 4 - No intervalo de tempo","x-nullable":true},"hIni":{"type":"string","description":"Hora inicial.\r\nFormato HH:MM:SS.","x-nullable":true},"hFim":{"type":"string","description":"Hora final.\r\nFormato HH:MM:SS.","x-nullable":true}},"required":["hFim","hIni","tpHor"]},"CteSefazObsCont":{"type":"object","description":"Campo de uso livre do contribuinte.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no XTexto.","properties":{"xCampo":{"type":"string","description":"Identificação do campo.","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do campo.","maxLength":160,"minLength":1,"x-nullable":true}},"required":["xTexto","xCampo"]},"CteSefazObsFisco":{"type":"object","description":"Campo de uso livre do contribuinte.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no XTexto.","properties":{"xCampo":{"type":"string","description":"Identificação do campo.","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do campo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTexto","xCampo"]},"CteSefazEmit":{"type":"object","description":"Identificação do Emitente do CT-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ do emitente.\r\nInformar zeros não significativos.\r\n\r\n***Obrigatório caso o emitente seja pessoa jurídica***.","x-nullable":true},"CPF":{"type":"string","description":"CPF do emitente.\r\nInformar zeros não significativos.\r\nUsar com série específica 920-969 para emitente pessoa física com inscrição estadual.\r\n\r\n***Obrigatorio caso o emitente seja pessoa física***.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual do Emitente.\r\nA IE do emitente somente ficará sem informação para o caso do Regime Especial da NFF (tpEmis=3).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"IEST":{"type":"string","description":"Inscrição Estadual do Substituto Tributário.","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou Nome do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"enderEmit":{"$ref":"#/definitions/CteSefazEndeEmi"},"CRT":{"type":"integer","description":"Código do Regime Tributário. Informar:\r\n* 1 - Simples Nacional;\r\n* 2 - Simples Nacional, excesso sublimite de receita bruta;\r\n* 3 - Regime Normal;\r\n* 4 - Simples Nacional - Microempreendedor Individual (MEI).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"CteSefazEndeEmi":{"type":"object","description":"Endereço do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","properties":{"xLgr":{"type":"string","description":"Logradouro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"fone":{"type":"string","description":"Telefone.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"CteSefazRem":{"type":"object","description":"Informações do Remetente das mercadorias transportadas pelo CT-e.\r\nPoderá não ser informado para os CT-e de redespacho intermediário e serviço vinculado a multimodal. Nos demais casos deverá sempre ser informado.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.\r\nInformar a IE do remetente ou ISENTO se remetente é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o remetente não seja contribuinte do ICMS não informar a tag.","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou nome do remetente.","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"enderReme":{"$ref":"#/definitions/CteSefazEndereco"},"email":{"type":"string","description":"Endereço de email.","x-nullable":true}},"required":["enderReme","xNome"]},"CteSefazExped":{"type":"object","description":"Informações do Expedidor da Carga.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.\r\nInformar a IE do expedidor ou ISENTO se expedidor é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o expedidor não seja contribuinte do ICMS não informar a tag.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"enderExped":{"$ref":"#/definitions/CteSefazEndereco"},"email":{"type":"string","description":"Endereço de email.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["enderExped","xNome"]},"CteSefazReceb":{"type":"object","description":"Informações do Recebedor da Carga.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.\r\nInformar a IE do recebedor ou ISENTO se recebedor é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o recebedor não seja contribuinte do ICMS não informar o conteúdo.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"enderReceb":{"$ref":"#/definitions/CteSefazEndereco"},"email":{"type":"string","description":"Endereço de email.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["enderReceb","xNome"]},"CteSefazDest":{"type":"object","description":"Informações do Destinatário do CT-e.\r\nPoderá não ser informado para os CT-e de redespacho intermediário e serviço vinculado a multimodal. Nos demais casos deverá sempre ser informado.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.\r\nInformar a IE do destinatário ou ISENTO se destinatário é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o destinatário não seja contribuinte do ICMS não informar o conteúdo.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do destinatário.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"ISUF":{"type":"string","description":"Inscrição na SUFRAMA.\r\n(Obrigatório nas operações com as áreas com benefícios de incentivos fiscais sob controle da SUFRAMA).","x-nullable":true},"enderDest":{"$ref":"#/definitions/CteSefazEndereco"},"email":{"type":"string","description":"Endereço de email.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["enderDest","xNome"]},"CteSefazVPrest":{"type":"object","description":"Valores da Prestação de Serviço.","properties":{"vTPrest":{"type":"number","description":"Valor Total da Prestação do Serviço.\r\nPode conter zeros quando o CT-e for de complemento de ICMS.","minimum":0,"x-nullable":true},"vRec":{"type":"number","description":"Valor a Receber.","minimum":0,"x-nullable":true},"Comp":{"type":"array","items":{"$ref":"#/definitions/CteSefazComp"}}},"required":["vRec","vTPrest"]},"CteSefazComp":{"type":"object","description":"Componentes do Valor da Prestação.","properties":{"xNome":{"type":"string","description":"Nome do componente.\r\nExxemplos: FRETE PESO, FRETE VALOR, SEC/CAT, ADEME, AGENDAMENTO, etc.","maxLength":15,"minLength":1,"x-nullable":true},"vComp":{"type":"number","description":"Valor do componente.","minimum":0,"x-nullable":true}},"required":["vComp","xNome"]},"CteSefazInfCte_Imp":{"type":"object","description":"Informações relativas aos Impostos.","properties":{"ICMS":{"$ref":"#/definitions/CteSefazImp"},"vTotTrib":{"type":"number","description":"Valor Total dos Tributos.","minimum":0,"x-nullable":true},"infAdFisco":{"type":"string","description":"Informações adicionais de interesse do Fisco.\r\nNorma referenciada, informações complementares, etc.","maxLength":2000,"minLength":1,"x-nullable":true},"ICMSUFFim":{"$ref":"#/definitions/CteSefazICMSUFFim"},"IBSCBS":{"$ref":"#/definitions/CteSefazTribCTe"},"vTotDFe":{"type":"number","description":"Valor total do documento fiscal\r\n(vTPrest + total do IBS + total da CBS).","minimum":0,"x-nullable":true}},"required":["ICMS"]},"CteSefazImp":{"type":"object","description":"Informações relativas ao ICMS.","properties":{"ICMS00":{"$ref":"#/definitions/CteSefazICMS00"},"ICMS20":{"$ref":"#/definitions/CteSefazICMS20"},"ICMS45":{"$ref":"#/definitions/CteSefazICMS45"},"ICMS60":{"$ref":"#/definitions/CteSefazICMS60"},"ICMS90":{"$ref":"#/definitions/CteSefazICMS90"},"ICMSOutraUF":{"$ref":"#/definitions/CteSefazICMSOutraUF"},"ICMSSN":{"$ref":"#/definitions/CteSefazICMSSN"}}},"CteSefazICMS00":{"type":"object","description":"Prestação sujeito à tributação normal do ICMS.","properties":{"CST":{"type":"string","description":"classificação Tributária do Serviço.\r\n* 00 - tributação normal ICMS","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true}},"required":["vICMS","pICMS","vBC","CST"]},"CteSefazICMS20":{"type":"object","description":"Prestação sujeito à tributação com redução de BC do ICMS.","properties":{"CST":{"type":"string","description":"Classificação Tributária do serviço.\r\n* 20 - tributação com BC reduzida do ICMS","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMS","pICMS","vBC","pRedBC","CST"]},"CteSefazICMS45":{"type":"object","description":"ICMS  Isento, não Tributado ou diferido.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\nPreencher com:\r\n* 40 - ICMS isenção\r\n* 41 - ICMS não tributada\r\n* 51 - ICMS diferido","x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["CST"]},"CteSefazICMS60":{"type":"object","description":"Tributação pelo ICMS60 - ICMS cobrado por substituição tributária.Responsabilidade do recolhimento do ICMS atribuído ao tomador ou 3º por ST.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 60 - ICMS cobrado por substituição tributária","x-nullable":true},"vBCSTRet":{"type":"number","description":"Valor da BC do ICMS ST retido.\r\nValor do frete sobre o qual será calculado o ICMS a ser substituído na Prestação.","minimum":0,"x-nullable":true},"vICMSSTRet":{"type":"number","description":"Valor do ICMS ST retido.\r\nResultado da multiplicação do “vBCSTRet” x “pICMSSTRet” - que será valor do ICMS a ser retido pelo Substituto. Podendo o valor do ICMS a ser retido efetivamente, sofrer ajustes conforme a opção tributaria do transportador substituído.","minimum":0,"x-nullable":true},"pICMSSTRet":{"type":"number","description":"Alíquota do ICMS.\r\nPercentual de Alíquota incidente na prestação de serviço de transporte.","minimum":0,"x-nullable":true},"vCred":{"type":"number","description":"Valor do Crédito outorgado/Presumido.\r\nPreencher somente quando o transportador substituído, for optante pelo crédito outorgado previsto no Convênio 106/96 e corresponde ao percentual de 20%% do valor do ICMS ST retido.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["pICMSSTRet","vICMSSTRet","vBCSTRet","CST"]},"CteSefazICMS90":{"type":"object","description":"ICMS Outros.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS outros","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vCred":{"type":"number","description":"Valor do Crédito Outorgado/Presumido.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMS","pICMS","vBC","CST"]},"CteSefazICMSOutraUF":{"type":"object","description":"ICMS devido à UF de origem da prestação, quando  diferente da UF do emitente.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS Outra UF","x-nullable":true},"pRedBCOutraUF":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBCOutraUF":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMSOutraUF":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMSOutraUF":{"type":"number","description":"Valor do ICMS devido outra UF.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMSOutraUF","pICMSOutraUF","vBCOutraUF","CST"]},"CteSefazICMSSN":{"type":"object","description":"Simples Nacional.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS Simples Nacional","x-nullable":true},"indSN":{"type":"integer","description":"Indica se o contribuinte é Simples Nacional\t\t\t1=Sim.","x-nullable":true}},"required":["indSN","CST"]},"CteSefazICMSUFFim":{"type":"object","description":"Informações do ICMS de partilha com a UF de término do serviço de transporte na operação interestadual.\r\nGrupo a ser informado nas prestações interestaduais para consumidor final, não contribuinte do ICMS.","properties":{"vBCUFFim":{"type":"number","description":"Valor da BC do ICMS na UF de término da prestação do serviço de transporte.","minimum":0,"x-nullable":true},"pFCPUFFim":{"type":"number","description":"Percentual do ICMS relativo ao Fundo de Combate à pobreza (FCP) na UF de término da prestação do serviço de transporte.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"pICMSUFFim":{"type":"number","description":"Alíquota interna da UF de término da prestação do serviço de transporte.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"pICMSInter":{"type":"number","description":"Alíquota interestadual das UF envolvidas.\r\nAlíquota interestadual das UF envolvidas.","minimum":0,"x-nullable":true},"vFCPUFFim":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate á Pobreza (FCP) da UF de término da prestação.","minimum":0,"x-nullable":true},"vICMSUFFim":{"type":"number","description":"Valor do ICMS de partilha para a UF de término da prestação do serviço de transporte.","minimum":0,"x-nullable":true},"vICMSUFIni":{"type":"number","description":"Valor do ICMS de partilha para a UF de início da prestação do serviço de transporte.","minimum":0,"x-nullable":true}},"required":["vICMSUFIni","vICMSUFFim","vFCPUFFim","pICMSInter","pICMSUFFim","pFCPUFFim","vBCUFFim"]},"CteSefazTribCTe":{"type":"object","description":"Grupo de informações do IBS e CBS.","properties":{"CST":{"type":"string","description":"Código Situação Tributária do IBS/CBS.","x-nullable":true},"cClassTrib":{"type":"string","x-nullable":true},"indDoacao":{"type":"integer","x-nullable":true},"gIBSCBS":{"$ref":"#/definitions/CteSefazCIBS"},"gEstornoCred":{"$ref":"#/definitions/CteSefazEstornoCred"}},"required":["CST"]},"CteSefazCIBS":{"type":"object","properties":{"vBC":{"type":"number","description":"Valor do BC.","minimum":0,"x-nullable":true},"gIBSUF":{"$ref":"#/definitions/CteSefazGIBSUF"},"gIBSMun":{"$ref":"#/definitions/CteSefazGIBSMun"},"vIBS":{"type":"number","description":"Valor do IBS.","minimum":0,"x-nullable":true},"gCBS":{"$ref":"#/definitions/CteSefazGCBS"},"gTribRegular":{"$ref":"#/definitions/CteSefazTribRegular"},"gTribCompraGov":{"$ref":"#/definitions/CteSefazTribCompraGov"}},"required":["gCBS","vIBS","gIBSMun","gIBSUF","vBC"]},"CteSefazGIBSUF":{"type":"object","description":"Grupo de informações do IBS na UF.","properties":{"pIBSUF":{"type":"number","description":"Aliquota do IBS de competência das UF (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteSefazDif"},"gDevTrib":{"$ref":"#/definitions/CteSefazDevTrib"},"gRed":{"$ref":"#/definitions/CteSefazRed"},"vIBSUF":{"type":"number","description":"Valor do IBS de competência das UF.","minimum":0,"x-nullable":true}},"required":["vIBSUF","pIBSUF"]},"CteSefazDif":{"type":"object","description":"Grupo de campos do Diferimento.","properties":{"pDif":{"type":"number","description":"Percentual do diferimento.","minimum":0,"x-nullable":true},"vDif":{"type":"number","description":"Valor do diferimento.","minimum":0,"x-nullable":true}},"required":["vDif","pDif"]},"CteSefazDevTrib":{"type":"object","description":"Grupo de Informações da devolução de tributos.","properties":{"vDevTrib":{"type":"number","description":"Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e\r\ngás natural e em outras hipóteses definidas no regulamento.","minimum":0,"x-nullable":true}},"required":["vDevTrib"]},"CteSefazRed":{"type":"object","description":"Grupo de campos da redução de aliquota.","properties":{"pRedAliq":{"type":"number","description":"Percentual de redução de aliquota do cClassTrib.","minimum":0,"x-nullable":true},"pAliqEfet":{"type":"number","description":"Aliquota Efetiva que será aplicada a Base de Calculo (em percentual).","minimum":0,"x-nullable":true}},"required":["pAliqEfet","pRedAliq"]},"CteSefazGIBSMun":{"type":"object","description":"Grupo de Informações do IBS no Município.","properties":{"pIBSMun":{"type":"number","description":"Aliquota do IBS Municipal (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteSefazDif"},"gDevTrib":{"$ref":"#/definitions/CteSefazDevTrib"},"gRed":{"$ref":"#/definitions/CteSefazRed"},"vIBSMun":{"type":"number","description":"Valor do IBS Municipal.","minimum":0,"x-nullable":true}},"required":["vIBSMun","pIBSMun"]},"CteSefazGCBS":{"type":"object","description":"Grupo de Tributação da CBS.","properties":{"pCBS":{"type":"number","description":"Aliquota da CBS (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteSefazDif"},"gDevTrib":{"$ref":"#/definitions/CteSefazDevTrib"},"gRed":{"$ref":"#/definitions/CteSefazRed"},"vCBS":{"type":"number","description":"Valor da CBS.","minimum":0,"x-nullable":true}},"required":["vCBS","pCBS"]},"CteSefazTribRegular":{"type":"object","description":"Grupo de informações da Tributação Regular. Informar como seria a tributação caso não cumprida a condição resolutória/suspensiva. Exemplo 1: Art. 442, §4. Operações com ZFM e ALC. Exemplo 2: Operações com suspensão do tributo.","properties":{"CSTReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS.\r\nInformar qual seria o CST caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"cClassTribReg":{"type":"string","description":"Informar qual seria o cClassTrib caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"pAliqEfetRegIBSUF":{"type":"number","description":"Alíquota do IBS da UF.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSUF":{"type":"number","description":"Valor do IBS da UF.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegIBSMun":{"type":"number","description":"Alíquota do IBS do Município.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSMun":{"type":"number","description":"Valor do IBS do Município.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegCBS":{"type":"number","description":"Alíquota da CBS.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegCBS":{"type":"number","description":"Valor da CBS.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true}},"required":["vTribRegCBS","pAliqEfetRegCBS","vTribRegIBSMun","pAliqEfetRegIBSMun","vTribRegIBSUF","pAliqEfetRegIBSUF","cClassTribReg","CSTReg"]},"CteSefazTribCompraGov":{"type":"object","description":"Grupo de informações da composição do valor do IBS e da CBS em compras governamental.","properties":{"pAliqIBSUF":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSUF":{"type":"number","description":"Valor que seria devido a UF, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqIBSMun":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSMun":{"type":"number","description":"Valor que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqCBS":{"type":"number","minimum":0,"x-nullable":true},"vTribCBS":{"type":"number","description":"Valor que seria devido a CBS, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true}},"required":["vTribCBS","vTribIBSMun","vTribIBSUF"]},"CteSefazEstornoCred":{"type":"object","description":"Informado conforme indicador no cClassTrib.","properties":{"vIBSEstCred":{"type":"number","description":"Valor do IBS a ser estornado.","minimum":0,"x-nullable":true},"vCBSEstCred":{"type":"number","description":"Valor da CBS a ser estornada.","minimum":0,"x-nullable":true}},"required":["vCBSEstCred","vIBSEstCred"]},"CteSefazInfCTeNorm":{"type":"object","description":"Grupo de informações do CT-e Normal e Substituto.","properties":{"infCarga":{"$ref":"#/definitions/CteSefazInfCarga"},"infDoc":{"$ref":"#/definitions/CteSefazInfDoc"},"docAnt":{"$ref":"#/definitions/CteSefazDocAnt"},"infModal":{"$ref":"#/definitions/CteSefazInfModal"},"veicNovos":{"type":"array","items":{"$ref":"#/definitions/CteSefazVeicNovos"}},"cobr":{"$ref":"#/definitions/CteSefazCobr"},"infCteSub":{"$ref":"#/definitions/CteSefazInfCteSub"},"infGlobalizado":{"$ref":"#/definitions/CteSefazInfGlobalizado"},"infServVinc":{"$ref":"#/definitions/CteSefazInfServVinc"}},"required":["infModal","infCarga"]},"CteSefazInfCarga":{"type":"object","description":"Informações da Carga do CT-e.","properties":{"vCarga":{"type":"number","description":"Valor total da carga.\r\nDever ser informado para todos os modais, com exceção para o Dutoviário.","minimum":0,"x-nullable":true},"proPred":{"type":"string","description":"Produto predominante.\r\nInformar a descrição do produto predominante.","maxLength":60,"minLength":1,"x-nullable":true},"xOutCat":{"type":"string","description":"Outras características da carga.\r\n\"FRIA\", \"GRANEL\", \"REFRIGERADA\", \"Medidas: 12X12X12\".","maxLength":30,"minLength":1,"x-nullable":true},"infQ":{"type":"array","items":{"$ref":"#/definitions/CteSefazInfQ"},"minItems":1},"vCargaAverb":{"type":"number","description":"Valor da Carga para efeito de averbação.\r\nNormalmente igual ao valor declarado da mercadoria, diferente por exemplo, quando a mercadoria transportada é isenta de tributos nacionais para exportação, onde é preciso averbar um valor maior, pois no caso de indenização, o valor a ser pago será maior.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}},"required":["infQ","proPred"]},"CteSefazInfQ":{"type":"object","description":"Informações de quantidades da Carga do CT-e.\r\nPara o Aéreo é obrigatório o preenchimento desse campo da seguinte forma.\r\n* 1 - Peso Bruto, sempre em quilogramas (obrigatório)\r\n* 2 - Peso Cubado\r\nsempre em quilogramas\r\n* 3 - Quantidade de volumes, sempre em unidades (obrigatório)\r\n* 4 - Cubagem, sempre em metros cúbicos (obrigatório apenas quando for impossível preencher as dimensões da(s) embalagem(ens) na tag xDime do leiaute do Aéreo)","properties":{"cUnid":{"type":"string","description":"Código da Unidade de Medida.\r\nPreencher com:\r\n* 00 - M3\r\n* 01 - KG\r\n* 02 - TON\r\n* 03 - UNIDADE\r\n* 04 - LITROS\r\n* 05 - MMBTU","x-nullable":true},"tpMed":{"type":"string","description":"Tipo da Medida.\r\nExemplos:\r\nPESO BRUTO, PESO DECLARADO, PESO CUBADO, PESO AFORADO, PESO AFERIDO, PESO BASE DE CÁLCULO, LITRAGEM, CAIXAS e etc.","maxLength":20,"minLength":1,"x-nullable":true},"qCarga":{"type":"number","description":"Quantidade.","minimum":0,"x-nullable":true}},"required":["qCarga","tpMed","cUnid"]},"CteSefazInfDoc":{"type":"object","description":"Informações dos documentos transportados pelo CT-e\r\nOpcional para Redespacho Intermediario e Serviço vinculado a multimodal.\r\nPoderá não ser informado para os CT-e de redespacho intermediário e serviço vinculado a multimodal. Nos demais casos deverá sempre ser informado.","properties":{"infNF":{"type":"array","items":{"$ref":"#/definitions/CteSefazInfNF"}},"infNFe":{"type":"array","items":{"$ref":"#/definitions/CteSefazInfNFe"}},"infOutros":{"type":"array","items":{"$ref":"#/definitions/CteSefazInfOutros"}},"infDCe":{"type":"array","items":{"$ref":"#/definitions/CteSefazInfDCe"}}}},"CteSefazInfNF":{"type":"object","description":"Informações das NF.\r\nEste grupo deve ser informado quando o documento originário for NF.","properties":{"nRoma":{"type":"string","description":"Número do Romaneio da NF.","maxLength":20,"minLength":1,"x-nullable":true},"nPed":{"type":"string","description":"Número do Pedido da NF.","maxLength":20,"minLength":1,"x-nullable":true},"mod":{"type":"string","description":"Modelo da Nota Fiscal.\r\nPreencher com:\r\n* 01 - NF Modelo 01/1A e Avulsa\r\n* 04 - NF de Produtor","x-nullable":true},"serie":{"type":"string","description":"Série.","maxLength":3,"minLength":1,"x-nullable":true},"nDoc":{"type":"string","description":"Número.","maxLength":20,"minLength":1,"x-nullable":true},"dEmi":{"type":"string","format":"date","description":"Data de Emissão.\r\nFormato AAAA-MM-DD.","x-nullable":true},"vBC":{"type":"number","description":"Valor da Base de Cálculo do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor Total do ICMS.","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da Base de Cálculo do ICMS ST.","minimum":0,"x-nullable":true},"vST":{"type":"number","description":"Valor Total do ICMS ST.","minimum":0,"x-nullable":true},"vProd":{"type":"number","description":"Valor Total dos Produtos.","minimum":0,"x-nullable":true},"vNF":{"type":"number","description":"Valor Total da NF.","minimum":0,"x-nullable":true},"nCFOP":{"type":"string","description":"CFOP Predominante.\r\nCFOP da NF ou, na existência de mais de um, predominância pelo critério de valor econômico.","x-nullable":true},"nPeso":{"type":"number","description":"Peso total em Kg.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"PIN":{"type":"string","description":"PIN SUFRAMA.\r\nPIN atribuído pela SUFRAMA para a operação.","maxLength":9,"minLength":2,"x-nullable":true},"dPrev":{"type":"string","format":"date","description":"Data prevista de entrega.\r\nFormato AAAA-MM-DD.","x-nullable":true},"infUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSefazUnidCarga"}},"infUnidTransp":{"type":"array","items":{"$ref":"#/definitions/CteSefazUnidadeTransp"}}},"required":["nCFOP","vNF","vProd","vST","vBCST","vICMS","vBC","dEmi","nDoc","serie","mod"]},"CteSefazUnidCarga":{"type":"object","description":"Informações das Unidades de Carga (Containeres/ULD/Outros).\r\nDispositivo de carga utilizada (Unit Load Device - ULD) significa todo tipo de contêiner de carga, vagão, contêiner de avião, palete de aeronave com rede ou palete de aeronave com rede sobre um iglu.","properties":{"tpUnidCarga":{"type":"integer","description":"Tipo da Unidade de Carga.\r\n* 1 - Container\r\n* 2 - ULD\r\n* 3 - Pallet\r\n* 4 - Outros","x-nullable":true},"idUnidCarga":{"type":"string","description":"Identificação da Unidade de Carga.\r\nInformar a identificação da unidade de carga, por exemplo: número do container.","maxLength":20,"minLength":1,"x-nullable":true},"lacUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSefazLacUnidCarga"}},"qtdRat":{"type":"number","description":"Quantidade rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["idUnidCarga","tpUnidCarga"]},"CteSefazLacUnidCarga":{"type":"object","description":"Lacres das Unidades de Carga.","properties":{"nLacre":{"type":"string","description":"Número do lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"CteSefazUnidadeTransp":{"type":"object","description":"Informações das Unidades de Transporte (Carreta/Reboque/Vagão).\r\nDeve ser preenchido com as informações das unidades de transporte utilizadas.","properties":{"tpUnidTransp":{"type":"integer","description":"Tipo da Unidade de Transporte.\r\n* 1 - Rodoviário Tração\r\n* 2 - Rodoviário Reboque\r\n* 3 - Navio\r\n* 4 - Balsa\r\n* 5 - Aeronave\r\n* 6 - Vagão\r\n* 7 - Outros","x-nullable":true},"idUnidTransp":{"type":"string","description":"Identificação da Unidade de Transporte.\r\nInformar a identificação conforme o tipo de unidade de transporte.\r\nPor exemplo: para rodoviário tração ou reboque deverá preencher com a placa do veículo.","maxLength":20,"minLength":1,"x-nullable":true},"lacUnidTransp":{"type":"array","items":{"$ref":"#/definitions/CteSefazLacUnidTransp"}},"infUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSefazUnidCarga"}},"qtdRat":{"type":"number","description":"Quantidade rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["idUnidTransp","tpUnidTransp"]},"CteSefazLacUnidTransp":{"type":"object","description":"Lacres das Unidades de Transporte.","properties":{"nLacre":{"type":"string","description":"Número do lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"CteSefazInfNFe":{"type":"object","description":"Informações das NF-e.","properties":{"chave":{"type":"string","description":"Chave de acesso da NF-e.","maxLength":44,"x-nullable":true},"PIN":{"type":"string","description":"PIN SUFRAMA.\r\nPIN atribuído pela SUFRAMA para a operação.","maxLength":9,"minLength":2,"x-nullable":true},"dPrev":{"type":"string","format":"date","description":"Data prevista de entrega.\r\nFormato AAAA-MM-DD.","x-nullable":true},"infUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSefazUnidCarga"}},"infUnidTransp":{"type":"array","items":{"$ref":"#/definitions/CteSefazUnidadeTransp"}}},"required":["chave"]},"CteSefazInfOutros":{"type":"object","description":"Informações dos demais documentos.","properties":{"tpDoc":{"type":"string","description":"Tipo de documento originário.\r\nPreencher com:\r\n* 00 - Declaração\r\n* 10 - Dutoviário\r\n* 59 - CF-e SAT\r\n* 65 - NFC-e\r\n* 99 - Outros","x-nullable":true},"descOutros":{"type":"string","description":"Descrição do documento.","maxLength":100,"minLength":1,"x-nullable":true},"nDoc":{"type":"string","description":"Número.","maxLength":20,"minLength":1,"x-nullable":true},"dEmi":{"type":"string","format":"date","description":"Data de Emissão.\r\nFormato AAAA-MM-DD.","x-nullable":true},"vDocFisc":{"type":"number","description":"Valor do documento.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"dPrev":{"type":"string","format":"date","description":"Data prevista de entrega.\r\nFormato AAAA-MM-DD.","x-nullable":true},"infUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSefazUnidCarga"}},"infUnidTransp":{"type":"array","items":{"$ref":"#/definitions/CteSefazUnidadeTransp"}}},"required":["tpDoc"]},"CteSefazInfDCe":{"type":"object","description":"Informações das DCe.","properties":{"chave":{"type":"string","description":"Chave de acesso da DCe.","maxLength":44,"x-nullable":true}},"required":["chave"]},"CteSefazDocAnt":{"type":"object","description":"Documentos de Transporte Anterior.","properties":{"emiDocAnt":{"type":"array","items":{"$ref":"#/definitions/CteSefazEmiDocAnt"},"minItems":1}},"required":["emiDocAnt"]},"CteSefazEmiDocAnt":{"type":"object","description":"Emissor do documento anterior.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","maxLength":14,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do expedidor.","maxLength":60,"minLength":1,"x-nullable":true},"idDocAnt":{"type":"array","items":{"$ref":"#/definitions/CteSefazIdDocAnt"},"maxItems":2,"minItems":1}},"required":["idDocAnt","xNome"]},"CteSefazIdDocAnt":{"type":"object","description":"Informações de identificação dos documentos de Transporte Anterior.","properties":{"idDocAntPap":{"type":"array","items":{"$ref":"#/definitions/CteSefazIdDocAntPap"}},"idDocAntEle":{"type":"array","items":{"$ref":"#/definitions/CteSefazIdDocAntEle"}}}},"CteSefazIdDocAntPap":{"type":"object","description":"Documentos de transporte anterior em papel.","properties":{"tpDoc":{"type":"string","description":"Tipo do Documento de Transporte Anterior.\r\nPreencher com:\r\n* 07 - ATRE\r\n* 08 - DTA (Despacho de Transito Aduaneiro)\r\n* 09 - Conhecimento Aéreo Internacional\r\n* 10 - Conhecimento - Carta de Porte Internacional\r\n* 11 - Conhecimento Avulso\r\n* 12 - TIF (Transporte Internacional Ferroviário)\r\n* 13 - BL (Bill of Lading)","x-nullable":true},"serie":{"type":"string","description":"Série do Documento Fiscal.","maxLength":3,"minLength":1,"x-nullable":true},"subser":{"type":"string","description":"Série do Documento Fiscal.","maxLength":2,"minLength":1,"x-nullable":true},"nDoc":{"type":"string","description":"Número do Documento Fiscal.","maxLength":30,"minLength":1,"x-nullable":true},"dEmi":{"type":"string","format":"date","description":"Data de emissão (AAAA-MM-DD).","x-nullable":true}},"required":["dEmi","nDoc","serie","tpDoc"]},"CteSefazIdDocAntEle":{"type":"object","description":"Documentos de transporte anterior eletrônicos.","properties":{"chCTe":{"type":"string","description":"Chave de acesso do CT-e.","maxLength":44,"x-nullable":true}},"required":["chCTe"]},"CteSefazInfModal":{"type":"object","description":"Informações do modal.","properties":{"versaoModal":{"type":"string","description":"Versão do leiaute específico para o Modal.","x-nullable":true},"rodo":{"$ref":"#/definitions/CteSefazRodo"},"aereo":{"$ref":"#/definitions/CteSefazAereo"},"ferrov":{"$ref":"#/definitions/CteSefazFerrov"},"aquav":{"$ref":"#/definitions/CteSefazAquav"},"duto":{"$ref":"#/definitions/CteSefazDuto"},"multimodal":{"$ref":"#/definitions/CteSefazMultimodal"}},"required":["versaoModal"]},"CteSefazRodo":{"type":"object","description":"Informações do modal Rodoviário.","properties":{"RNTRC":{"type":"string","description":"Registro Nacional de Transportadores Rodoviários de Carga.\r\nRegistro obrigatório do emitente do CT-e junto à ANTT para exercer a atividade de transportador rodoviário de cargas por conta de terceiros e mediante remuneração.","x-nullable":true},"occ":{"type":"array","items":{"$ref":"#/definitions/CteSefazOcc"},"maxItems":10}},"required":["RNTRC"]},"CteSefazOcc":{"type":"object","description":"Ordens de Coleta associados.","properties":{"serie":{"type":"string","description":"Série da OCC.","maxLength":3,"minLength":1,"x-nullable":true},"nOcc":{"type":"integer","description":"Número da Ordem de coleta.","maximum":999999,"minimum":1,"x-nullable":true},"dEmi":{"type":"string","format":"date","description":"Data de emissão da ordem de coleta.\r\nFormato AAAA-MM-DD.","x-nullable":true},"emiOcc":{"$ref":"#/definitions/CteSefazEmiOcc"}},"required":["dEmi","nOcc"]},"CteSefazEmiOcc":{"type":"object","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar os zeros não significativos.","x-nullable":true},"cInt":{"type":"string","description":"Código interno de uso da transportadora.\r\nUso intermo das transportadoras.","maxLength":10,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","maxLength":14,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true}},"required":["UF","IE","CNPJ"]},"CteSefazAereo":{"type":"object","description":"Informações do modal Aéreo.","properties":{"nMinu":{"type":"integer","description":"Número da Minuta.\r\nDocumento que precede o CT-e, assinado pelo expedidor, espécie de pedido de serviço.","maximum":999999999,"minimum":0,"x-nullable":true},"nOCA":{"type":"string","description":"Número Operacional do Conhecimento Aéreo.\r\nRepresenta o número de controle comumente utilizado pelo conhecimento aéreo composto por uma sequência numérica de onze dígitos. Os três primeiros dígitos representam um código que os operadores de transporte aéreo associados à IATA possuem. Em seguida um número de série de sete dígitos determinados pelo operador de transporte aéreo. Para finalizar, um dígito verificador, que é um sistema de módulo sete imponderado o qual divide o número de série do conhecimento aéreo por sete e usa o resto como dígito de verificação.","x-nullable":true},"dPrevAereo":{"type":"string","format":"date","description":"Data prevista da entrega.\r\nFormato AAAA-MM-DD.","x-nullable":true},"natCarga":{"$ref":"#/definitions/CteSefazNatCarga"},"tarifa":{"$ref":"#/definitions/CteSefazTarifa"},"peri":{"type":"array","items":{"$ref":"#/definitions/CteSefazPeri"}}},"required":["tarifa","natCarga","dPrevAereo"]},"CteSefazNatCarga":{"type":"object","description":"Natureza da carga.","properties":{"xDime":{"type":"string","description":"Dimensão.\r\nFormato:1234X1234X1234 (cm). Esse campo deve sempre que possível ser preenchido. Entretanto, quando for impossível o preenchimento das dimensões, fica obrigatório o preenchimento da cubagem em metro cúbico do leiaute do CT-e da estrutura genérica (infQ).","maxLength":14,"minLength":5,"x-nullable":true},"cInfManu":{"type":"array","description":"Informações de manuseio.\r\n* 01 - certificado do expedidor para embarque de animal vivo\r\n* 02 - artigo perigoso conforme Declaração do Expedidor anexa\r\n* 03 - somente em aeronave cargueira\r\n* 04 - artigo perigoso - declaração do expedidor não requerida\r\n* 05 - artigo perigoso em quantidade isenta\r\n* 06 - gelo seco para refrigeração (especificar no campo observações a quantidade)\r\n* 07 - não restrito (especificar a Disposição Especial no campo observações)\r\n* 08 - artigo perigoso em carga consolidada (especificar a quantidade no campo observações)\r\n* 09 - autorização da autoridade governamental anexa (especificar no campo observações)\r\n* 10 - baterias de íons de lítio em conformidade com a Seção II da PI965 - CAO\r\n* 11 - baterias de íons de lítio em conformidade com a Seção II da PI966\r\n* 12 - baterias de íons de lítio em conformidade com a Seção II da PI967\r\n* 13 - baterias de metal lítio em conformidade com a Seção II da PI968 — CAO\r\n* 14 - baterias de metal lítio em conformidade com a Seção II da PI969\r\n* 15 - baterias de metal lítio em conformidade com a Seção II da PI970\r\n* 99 - outro (especificar no campo observações)","items":{"type":"string"}}}},"CteSefazTarifa":{"type":"object","description":"Informações de tarifa.","properties":{"CL":{"type":"string","description":"Classe.\r\nPreencher com:\r\n* M - Tarifa Mínima\r\n* G - Tarifa Geral\r\n* E - Tarifa Específica","maxLength":1,"x-nullable":true},"cTar":{"type":"string","description":"Código da Tarifa.\r\nDeverão ser incluídos os códigos de três dígitos, correspondentes à tarifa.","maxLength":4,"minLength":1,"x-nullable":true},"vTar":{"type":"number","description":"Valor da Tarifa.\r\nValor da tarifa por kg quando for o caso.","minimum":0,"x-nullable":true}},"required":["vTar","CL"]},"CteSefazPeri":{"type":"object","description":"Preenchido quando for  transporte de produtos classificados pela ONU como perigosos.\r\nO preenchimento desses campos não desobriga a empresa aérea de emitir os demais documentos que constam na legislação vigente.","properties":{"nONU":{"type":"string","description":"Número ONU/UN.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","x-nullable":true},"qTotEmb":{"type":"string","description":"Quantidade total de volumes contendo artigos perigosos.\r\nPreencher com o número de volumes (unidades) de artigos perigosos, ou seja, cada embalagem devidamente marcada e etiquetada (por ex.: número de caixas, de tambores, de bombonas, dentre outros). Não deve ser preenchido com o número de ULD, pallets ou containers.","maxLength":20,"minLength":1,"x-nullable":true},"infTotAP":{"$ref":"#/definitions/CteSefazInfTotAP"}},"required":["infTotAP","qTotEmb","nONU"]},"CteSefazInfTotAP":{"type":"object","description":"Grupo de informações das quantidades totais de artigos perigosos.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","properties":{"qTotProd":{"type":"number","description":"Quantidade total de artigos perigosos.\r\n15 posições, sendo 11 inteiras e 4 decimais.\r\nDeve indicar a quantidade total do artigo perigoso, tendo como base a unidade referenciada na Tabela 3-1 do Doc 9284, por exemplo: litros\r\nquilogramas\r\nquilograma bruto etc. O preenchimento não deve, entretanto, incluir a unidade de medida. No caso de transporte de material radioativo, deve-se indicar o somatório dos Índices de Transporte (TI). Não indicar a quantidade do artigo perigoso por embalagem.","minimum":0,"x-nullable":true},"uniAP":{"type":"integer","description":"Unidade de medida.\r\n* 1 - KG\r\n* 2 - KG G (quilograma bruto)\r\n* 3 - LITROS\r\n* 4 - TI (índice de transporte para radioativos)\r\n* 5 - Unidades (apenas para artigos perigosos medidos em unidades que não se enquadram nos itens acima. Exemplo: baterias, celulares, equipamentos, veículos, dentre outros)","x-nullable":true}},"required":["uniAP","qTotProd"]},"CteSefazFerrov":{"type":"object","description":"Informações do modal Ferroviário.","properties":{"tpTraf":{"type":"integer","description":"Tipo de Tráfego.\r\nPreencher com:\r\n* 0 - Próprio\r\n* 1 - Mútuo\r\n* 2 - Rodoferroviário\r\n* 3 - Rodoviário","x-nullable":true},"trafMut":{"$ref":"#/definitions/CteSefazTrafMut"},"fluxo":{"type":"string","description":"Fluxo Ferroviário.\r\nTrata-se de um número identificador do contrato firmado com o cliente.","maxLength":10,"minLength":1,"x-nullable":true}},"required":["fluxo","tpTraf"]},"CteSefazTrafMut":{"type":"object","description":"Detalhamento de informações para o tráfego mútuo.","properties":{"respFat":{"type":"integer","description":"Responsável pelo Faturamento.\r\nPreencher com:\r\n* 1 - Ferrovia de origem\r\n* 2 - Ferrovia de destino","x-nullable":true},"ferrEmi":{"type":"integer","description":"Ferrovia Emitente do CTe.\r\nPreencher com:\r\n* 1 - Ferrovia de origem\r\n* 2 - Ferrovia de destino","x-nullable":true},"vFrete":{"type":"number","description":"Valor do Frete do Tráfego Mútuo.","minimum":0,"x-nullable":true},"chCTeFerroOrigem":{"type":"string","description":"Chave de acesso do CT-e emitido pelo ferrovia de origem.","maxLength":44,"x-nullable":true},"ferroEnv":{"type":"array","items":{"$ref":"#/definitions/CteSefazFerroEnv"}}},"required":["vFrete","ferrEmi","respFat"]},"CteSefazFerroEnv":{"type":"object","description":"Informações das Ferrovias Envolvidas.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar o CNPJ da Ferrovia Envolvida. Caso a Ferrovia envolvida não seja inscrita no CNPJ o campo deverá preenchido com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"cInt":{"type":"string","description":"Código interno da Ferrovia envolvida.\r\nUso da transportadora.","maxLength":10,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","maxLength":14,"x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome.","maxLength":60,"minLength":2,"x-nullable":true},"enderFerro":{"$ref":"#/definitions/CteSefazEnderFer"}},"required":["enderFerro","xNome","CNPJ"]},"CteSefazEnderFer":{"type":"object","description":"Dados do endereço da ferrovia envolvida.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":255,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município.\r\nUtilizar a tabela do IBGE\r\nInformar 9999999 para operações com o exterior.","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\nInformar EXTERIOR para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true}},"required":["UF","CEP","xMun","cMun","xLgr"]},"CteSefazAquav":{"type":"object","description":"Informações do modal Aquaviário.","properties":{"vPrest":{"type":"number","description":"Valor da Prestação Base de Cálculo do AFRMM.","minimum":0,"x-nullable":true},"vAFRMM":{"type":"number","description":"AFRMM (Adicional de Frete para Renovação da Marinha Mercante).","minimum":0,"x-nullable":true},"xNavio":{"type":"string","description":"Identificação do Navio.","maxLength":60,"minLength":1,"x-nullable":true},"balsa":{"type":"array","items":{"$ref":"#/definitions/CteSefazBalsa"},"maxItems":3},"nViag":{"type":"string","description":"Número da Viagem.","x-nullable":true},"direc":{"type":"string","description":"Direção.\r\nPreencher com: N-Norte, L-Leste, S-Sul, O-Oeste.","x-nullable":true},"irin":{"type":"string","description":"Irin do navio sempre deverá ser informado.","maxLength":10,"minLength":1,"x-nullable":true},"detCont":{"type":"array","items":{"$ref":"#/definitions/CteSefazDetCont"}},"tpNav":{"type":"integer","description":"Tipo de Navegação.\r\nPreencher com:\r\n* 0 - Interior\r\n* 1 - Cabotagem","x-nullable":true}},"required":["irin","direc","xNavio","vAFRMM","vPrest"]},"CteSefazBalsa":{"type":"object","description":"Grupo de informações das balsas.","properties":{"xBalsa":{"type":"string","description":"Identificador da Balsa.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xBalsa"]},"CteSefazDetCont":{"type":"object","description":"Grupo de informações de detalhamento dos conteiners\r\n(Somente para Redespacho Intermediário e Serviço Vinculado a Multimodal).","properties":{"nCont":{"type":"string","description":"Identificação do Container.","maxLength":20,"minLength":1,"x-nullable":true},"lacre":{"type":"array","items":{"$ref":"#/definitions/CteSefazLacre"},"maxItems":3},"infDoc":{"$ref":"#/definitions/CteSefazDetCont_InfDoc"}},"required":["nCont"]},"CteSefazLacre":{"type":"object","description":"Grupo de informações dos lacres dos cointainers da qtde da carga.","properties":{"nLacre":{"type":"string","description":"Lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"CteSefazDetCont_InfDoc":{"type":"object","description":"Informações dos documentos dos conteiners.","properties":{"infNF":{"type":"array","items":{"$ref":"#/definitions/CteSefazDetCont_InfDoc_InfNF"}},"infNFe":{"type":"array","items":{"$ref":"#/definitions/CteSefazDetCont_InfDoc_InfNFe"}}}},"CteSefazDetCont_InfDoc_InfNF":{"type":"object","description":"Informações das NF.","properties":{"serie":{"type":"string","description":"Série.","maxLength":3,"minLength":1,"x-nullable":true},"nDoc":{"type":"string","description":"Número.","maxLength":20,"minLength":1,"x-nullable":true},"unidRat":{"type":"number","description":"Unidade de medida rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["nDoc","serie"]},"CteSefazDetCont_InfDoc_InfNFe":{"type":"object","description":"Informações das NFe.","properties":{"chave":{"type":"string","description":"Chave de acesso da NF-e.","maxLength":44,"x-nullable":true},"unidRat":{"type":"number","description":"Unidade de medida rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["chave"]},"CteSefazDuto":{"type":"object","description":"Informações do modal Dutoviário.","properties":{"vTar":{"type":"number","description":"Valor da tarifa.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"dIni":{"type":"string","format":"date","description":"Data de Início da prestação do serviço.","x-nullable":true},"dFim":{"type":"string","format":"date","description":"Data de Fim da prestação do serviço.","x-nullable":true},"classDuto":{"type":"integer","description":"Classificação do Dutoviário.\r\nInformar: 1 - Gasoduto 2 - Mineroduto 3 - Oleoduto.","x-nullable":true},"tpContratacao":{"type":"integer","description":"Tipo de contratação do serviço de transporte (apenas para gasoduto).\r\nInformar:\r\n* 0 - Ponta a ponto\r\n* 1 - Capacidade de Entrada\r\n* 2 - Capacidade de Saida","x-nullable":true},"codPontoEntrada":{"type":"string","description":"Código do Ponto de Entrada.","maxLength":20,"minLength":2,"x-nullable":true},"codPontoSaida":{"type":"string","description":"Código do Ponto de Saída.","maxLength":20,"minLength":2,"x-nullable":true},"nContrato":{"type":"string","description":"Número do Contrato de Capacidade.","maxLength":20,"minLength":2,"x-nullable":true}},"required":["dFim","dIni"]},"CteSefazMultimodal":{"type":"object","description":"Informações do Multimodal.","properties":{"COTM":{"type":"string","description":"Número do Certificado do Operador de Transporte Multimodal.","maxLength":20,"minLength":1,"x-nullable":true},"indNegociavel":{"type":"integer","description":"Indicador Negociável\r\nPreencher com: 0 - Não Negociável\r\n* 1 - Negociável","x-nullable":true},"seg":{"$ref":"#/definitions/CteSefazSeg"}},"required":["indNegociavel","COTM"]},"CteSefazSeg":{"type":"object","description":"Informações de Seguro do Multimodal.","properties":{"infSeg":{"$ref":"#/definitions/CteSefazInfSeg"},"nApol":{"type":"string","description":"Número da Apólice.\r\nObrigatório pela lei 11.442/07 (RCTRC).","maxLength":20,"minLength":1,"x-nullable":true},"nAver":{"type":"string","description":"Número da Averbação.\r\nNão é obrigatório, pois muitas averbações ocorrem aapós a emissão do CT, mensalmente, por exemplo.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nAver","nApol","infSeg"]},"CteSefazInfSeg":{"type":"object","description":"Informações da seguradora.","properties":{"xSeg":{"type":"string","description":"Nome da Seguradora.","maxLength":30,"minLength":1,"x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ da seguradora.\r\nObrigatório apenas se responsável pelo seguro for (2) responsável pela contratação do transporte - pessoa jurídica.","x-nullable":true}},"required":["CNPJ","xSeg"]},"CteSefazVeicNovos":{"type":"object","description":"informações dos veículos transportados.","properties":{"chassi":{"type":"string","description":"Chassi do veículo.","maxLength":17,"x-nullable":true},"cCor":{"type":"string","description":"Cor do veículo.\r\nCódigo de cada montadora.","maxLength":4,"minLength":1,"x-nullable":true},"xCor":{"type":"string","description":"Descrição da cor.","maxLength":40,"minLength":1,"x-nullable":true},"cMod":{"type":"string","description":"Código Marca Modelo.\r\nUtilizar tabela RENAVAM.","maxLength":6,"minLength":1,"x-nullable":true},"vUnit":{"type":"number","description":"Valor Unitário do Veículo.","minimum":0,"x-nullable":true},"vFrete":{"type":"number","description":"Frete Unitário.","minimum":0,"x-nullable":true}},"required":["vFrete","vUnit","cMod","xCor","cCor","chassi"]},"CteSefazCobr":{"type":"object","description":"Dados da cobrança do CT-e.","properties":{"fat":{"$ref":"#/definitions/CteSefazFat"},"dup":{"type":"array","items":{"$ref":"#/definitions/CteSefazDup"}}}},"CteSefazFat":{"type":"object","description":"Dados da fatura.","properties":{"nFat":{"type":"string","description":"Número da fatura.","maxLength":60,"minLength":1,"x-nullable":true},"vOrig":{"type":"number","description":"Valor original da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDesc":{"type":"number","description":"Valor do desconto da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vLiq":{"type":"number","description":"Valor líquido da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}}},"CteSefazDup":{"type":"object","description":"Dados das duplicatas.","properties":{"nDup":{"type":"string","description":"Número da duplicata.","maxLength":60,"minLength":1,"x-nullable":true},"dVenc":{"type":"string","format":"date","description":"Data de vencimento da duplicata (AAAA-MM-DD).","x-nullable":true},"vDup":{"type":"number","description":"Valor da duplicata.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}}},"CteSefazInfCteSub":{"type":"object","description":"Informações do CT-e de substituição.","properties":{"chCte":{"type":"string","description":"Chave de acesso do CT-e a ser substituído (original).","x-nullable":true},"indAlteraToma":{"type":"integer","description":"Indicador de CT-e Alteração de Tomador.","x-nullable":true}},"required":["chCte"]},"CteSefazInfGlobalizado":{"type":"object","description":"Informações do CT-e Globalizado.","properties":{"xObs":{"type":"string","description":"Preencher com informações adicionais, legislação do regime especial, etc.","maxLength":256,"minLength":15,"x-nullable":true}},"required":["xObs"]},"CteSefazInfServVinc":{"type":"object","description":"Informações do Serviço Vinculado a Multimodal.","properties":{"infCTeMultimodal":{"type":"array","items":{"$ref":"#/definitions/CteSefazInfCTeMultimodal"},"minItems":1}},"required":["infCTeMultimodal"]},"CteSefazInfCTeMultimodal":{"type":"object","description":"informações do CT-e multimodal vinculado.","properties":{"chCTeMultimodal":{"type":"string","description":"Chave de acesso do CT-e Multimodal.","maxLength":44,"x-nullable":true}},"required":["chCTeMultimodal"]},"CteSefazInfCteComp":{"type":"object","description":"Detalhamento do CT-e complementado.","properties":{"chCTe":{"type":"string","description":"Chave do CT-e complementado.","maxLength":44,"x-nullable":true}},"required":["chCTe"]},"CteSefazAutXML":{"type":"object","description":"Autorizados para download do XML do DF-e.\r\nInformar CNPJ ou CPF. Preencher os zeros não significativos.","properties":{"CNPJ":{"type":"string","description":"CNPJ do autorizado.\r\nInformar zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"CPF do autorizado.\r\nInformar zeros não significativos.","x-nullable":true}}},"CteSefazRespTec":{"type":"object","description":"Informações do Responsável Técnico pela emissão do DF-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ da pessoa jurídica responsável técnica pelo sistema utilizado na emissão do documento fiscal eletrônico.\r\nInformar o CNPJ da pessoa jurídica desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico.","x-nullable":true},"xContato":{"type":"string","description":"Nome da pessoa a ser contatada.\r\nInformar o nome da pessoa a ser contatada na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico. No caso de pessoa física, informar o respectivo nome.","maxLength":60,"minLength":2,"x-nullable":true},"email":{"type":"string","description":"Email da pessoa jurídica a ser contatada.","maxLength":60,"minLength":1,"x-nullable":true},"fone":{"type":"string","description":"Telefone da pessoa jurídica a ser contatada.\r\nPreencher com o Código DDD + número do telefone.","x-nullable":true},"idCSRT":{"type":"integer","description":"Identificador do código de segurança do responsável técnico.\r\nIdentificador do CSRT utilizado para geração do hash.","maximum":999,"minimum":0,"x-nullable":true},"CSRT":{"type":"string","description":"Código de Segurança do Responsável Técnico utilizado para montar o hash do CSRT.","x-nullable":true},"hashCSRT":{"type":"string","description":"Hash do token do código de segurança do responsável técnico.\r\nO hashCSRT é o resultado das funções SHA-1 e base64 do token CSRT fornecido pelo fisco + chave de acesso do DF-e. (Implementação em futura NT)\r\nObservação: 28 caracteres são representados no schema como 20 bytes do tipo base64Binary.\r\n\r\n*Se não informado, será calculado automaticamente, desde que os campos `idCSRT` e `CSRT` sejam fornecidos.*","maxLength":28,"x-nullable":true}},"required":["fone","email","xContato","CNPJ"]},"CteSefazInfSolicNFF":{"type":"object","description":"Grupo de informações do pedido de emissão da Nota Fiscal Fácil.","properties":{"xSolic":{"type":"string","description":"Solicitação do pedido de emissão da NFF.\r\nSerá preenchido com a totalidade de campos informados no aplicativo emissor serializado.","maxLength":8000,"minLength":2,"x-nullable":true}},"required":["xSolic"]},"CteSefazInfCTeSupl":{"type":"object","description":"Informações suplementares do CT-e.","properties":{"qrCodCTe":{"type":"string","description":"Texto com o QR-Code impresso no DACTE.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":1000,"minLength":50,"x-nullable":true}}},"CteSimpPedidoEmissao":{"type":"object","properties":{"infCte":{"$ref":"#/definitions/CteSimpSefazInfCteSimp"},"infCTeSupl":{"$ref":"#/definitions/CteSimpSefazInfCTeSuplSimp"},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true}},"required":["ambiente","infCte"]},"CteSimpSefazInfCteSimp":{"type":"object","description":"Informações do CT-e.","properties":{"versao":{"type":"string","description":"Versão do leiaute.\r\nEx: \"4.00\".","x-nullable":true},"Id":{"type":"string","description":"Identificador da tag a ser assinada.\r\nInformar a chave de acesso do CT-e e precedida do literal \"CTe\".\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"ide":{"$ref":"#/definitions/CteSimpSefazIdeSimp"},"compl":{"$ref":"#/definitions/CteSimpSefazComplSimp"},"emit":{"$ref":"#/definitions/CteSimpSefazEmitSimp"},"toma":{"$ref":"#/definitions/CteSimpSefazTomaSimp"},"infCarga":{"$ref":"#/definitions/CteSimpSefazInfCargaSimp"},"det":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazDetSimp"},"maxItems":999,"minItems":1},"infModal":{"$ref":"#/definitions/CteSimpSefazInfModalSimp"},"cobr":{"$ref":"#/definitions/CteSimpSefazCobrSimp"},"infCteSub":{"$ref":"#/definitions/CteSimpSefazInfCteSubSimp"},"imp":{"$ref":"#/definitions/CteSimpSefazInfCte_ImpSimp"},"total":{"$ref":"#/definitions/CteSimpSefazTotalSimp"},"autXML":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazAutXMLSimp"},"maxItems":10},"infRespTec":{"$ref":"#/definitions/CteSimpSefazRespTecSimp"},"infSolicNFF":{"$ref":"#/definitions/CteSimpSefazInfSolicNFFSimp"}},"required":["total","imp","infModal","det","infCarga","toma","emit","ide","versao"]},"CteSimpSefazIdeSimp":{"type":"object","description":"Identificação do CT-e.","properties":{"cUF":{"type":"integer","description":"Código da UF do emitente do CT-e.\r\nUtilizar a Tabela do IBGE.","x-nullable":true},"cCT":{"type":"string","description":"Código numérico que compõe a Chave de Acesso.\r\nNúmero aleatório gerado pelo emitente para cada CT-e, com o objetivo de evitar acessos indevidos ao documento.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"CFOP":{"type":"string","description":"Código Fiscal de Operações e Prestações.","x-nullable":true},"natOp":{"type":"string","description":"Natureza da Operação.","maxLength":60,"minLength":1,"x-nullable":true},"mod":{"type":"integer","description":"Modelo do documento fiscal.\r\nUtilizar o código 57 para identificação do CT-e, emitido em substituição aos modelos de conhecimentos em papel.","x-nullable":true},"serie":{"type":"integer","description":"Série do CT-e.\r\nPreencher com \"0\" no caso de série única.","maximum":999,"minimum":0,"x-nullable":true},"nCT":{"type":"integer","description":"Número do CT-e.","maximum":999999999,"minimum":1,"x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e hora de emissão do CT-e.\r\nFormato AAAA-MM-DDTHH:MM:DD TZD.","x-nullable":true},"tpImp":{"type":"integer","description":"Formato de impressão do DACTE:\r\n* 1 - Retrato\r\n* 2 - Paisagem","x-nullable":true},"tpEmis":{"type":"integer","description":"Forma de emissão do CT-e.\r\nPreencher com:\r\n* 1 - Normal\r\n* 3 - Regime Especial NFF\r\n* 4 - EPEC pela SVC\r\n* 7 - Autorização pela SVC-RS\r\n* 8 - Autorização pela SVC-SP","x-nullable":true},"cDV":{"type":"integer","description":"Digito Verificador da chave de acesso do CT-e.\r\nInformar o dígito  de controle da chave de acesso do CT-e, que deve ser calculado com a aplicação do algoritmo módulo 11 (base 2,9) da chave de acesso.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maximum":9,"minimum":0,"x-nullable":true},"tpAmb":{"type":"integer","description":"Tipo do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"tpCTe":{"type":"integer","description":"Tipo do CT-e Simplificado.\r\nPreencher com:\r\n* 5 - CTe Simplificado\r\n* 6 - Substituição CTe Simplificado","x-nullable":true},"procEmi":{"type":"integer","description":"Identificador do processo de emissão do CT-e.\r\nPreencher com:\r\n* 0 - emissão de CT-e com aplicativo do contribuinte\r\n* 3 - emissão CT-e pelo contribuinte com aplicativo fornecido pelo SEBRAE","x-nullable":true},"verProc":{"type":"string","description":"Versão do processo de emissão.\r\nInformar a versão do aplicativo emissor de CT-e.","maxLength":20,"minLength":1,"x-nullable":true},"cMunEnv":{"type":"string","description":"Código do Município de envio do CT-e (de onde o documento foi transmitido).\r\nUtilizar a tabela do IBGE. Informar 9999999 para as operações com o exterior.","x-nullable":true},"xMunEnv":{"type":"string","description":"Nome do Município de envio do CT-e (de onde o documento foi transmitido).\r\nInformar PAIS/Municipio para as operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UFEnv":{"type":"string","description":"Sigla da UF de envio do CT-e (de onde o documento foi transmitido).\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"modal":{"type":"string","description":"Modal. Preencher com:\r\n* 01 - Rodoviário\r\n* 02 - Aéreo\r\n* 03 - Aquaviário\r\n* 04 - Ferroviário\r\n* 05 - Dutoviário\r\n* 06 - Multimodal","x-nullable":true},"tpServ":{"type":"integer","description":"Tipo do Serviço.\r\nPreencher com:\r\n* 0 - Normal\r\n* 1 - Subcontratação\r\n* 2 - Redespacho","x-nullable":true},"UFIni":{"type":"string","description":"UF do início da prestação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"UFFim":{"type":"string","description":"UF do término da prestação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"retira":{"type":"integer","description":"Indicador se o Recebedor retira no Aeroporto, Filial, Porto ou Estação de Destino? Preencher com:\r\n* 0 - Sim\r\n* 1 - Não","x-nullable":true},"xDetRetira":{"type":"string","description":"Detalhes do retira.","maxLength":160,"minLength":1,"x-nullable":true},"dhCont":{"type":"string","format":"date-time","description":"Data e Hora da entrada em contingência.\r\nInformar a data e hora no formato AAAA-MM-DDTHH:MM:SS.","x-nullable":true},"xJust":{"type":"string","description":"Justificativa da entrada em contingência.","maxLength":256,"minLength":15,"x-nullable":true},"gCompraGov":{"$ref":"#/definitions/CteSimpSefazCompraGovReduzidoSimp"}},"required":["retira","UFFim","UFIni","tpServ","modal","UFEnv","xMunEnv","cMunEnv","verProc","procEmi","tpCTe","tpEmis","tpImp","dhEmi","nCT","serie","natOp","CFOP","cUF"]},"CteSimpSefazCompraGovReduzidoSimp":{"type":"object","description":"Grupo de Compras Governamentais.","properties":{"tpEnteGov":{"type":"integer","description":"Para administração pública direta e suas autarquias e fundações:\r\n* 1 - União\r\n* 2 - Estados\r\n* 3 - Distrito Federal\r\n* 4 - Municípios","x-nullable":true},"pRedutor":{"type":"number","description":"Percentual de redução de aliquota em compra governamental.","minimum":0,"x-nullable":true}},"required":["pRedutor","tpEnteGov"]},"CteSimpSefazComplSimp":{"type":"object","description":"Dados complementares do CT-e para fins operacionais ou comerciais.","properties":{"xCaracAd":{"type":"string","description":"Característica adicional do transporte.\r\nTexto livre:\r\nREENTREGA\r\nDEVOLUÇÃO\r\nREFATURAMENTO\r\netc.","maxLength":15,"minLength":1,"x-nullable":true},"xCaracSer":{"type":"string","description":"Característica adicional do serviço.\r\nTexto livre:\r\nENTREGA EXPRESSA\r\nLOGÍSTICA REVERSA\r\nCONVENCIONAL\r\nEMERGENCIAL\r\netc.","maxLength":30,"minLength":1,"x-nullable":true},"fluxo":{"$ref":"#/definitions/CteSimpSefazFluxoSimp"},"xObs":{"type":"string","description":"Observações Gerais.","maxLength":2000,"minLength":1,"x-nullable":true},"ObsCont":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazObsContSimp"},"maxItems":10},"ObsFisco":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazObsFiscoSimp"},"maxItems":10}}},"CteSimpSefazFluxoSimp":{"type":"object","description":"Previsão do fluxo da carga.\r\nPreenchimento obrigatório para o modal aéreo.","properties":{"xOrig":{"type":"string","description":"Sigla ou código interno da Filial/Porto/Estação/ Aeroporto de Origem.\r\nObservações para o modal aéreo:\r\n* Preenchimento obrigatório para o modal aéreo.","maxLength":60,"minLength":1,"x-nullable":true},"pass":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazPassSimp"}},"xDest":{"type":"string","description":"Sigla ou código interno da Filial/Porto/Estação/Aeroporto de Destino.\r\nObservações para o modal aéreo:\r\n* Preenchimento obrigatório para o modal aéreo.","maxLength":60,"minLength":1,"x-nullable":true},"xRota":{"type":"string","description":"Código da Rota de Entrega.","maxLength":10,"minLength":1,"x-nullable":true}}},"CteSimpSefazPassSimp":{"type":"object","properties":{"xPass":{"type":"string","description":"Sigla ou código interno da Filial/Porto/Estação/Aeroporto de Passagem.\r\nObservação para o modal aéreo:\r\n* O código de três letras IATA, referente ao aeroporto de transferência, deverá ser incluído, quando for o caso. Quando não for possível,  utilizar a sigla OACI. Qualquer solicitação de itinerário deverá ser incluída.","maxLength":15,"minLength":1,"x-nullable":true}}},"CteSimpSefazObsContSimp":{"type":"object","description":"Campo de uso livre do contribuinte.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no XTexto.","properties":{"xCampo":{"type":"string","description":"Identificação do campo.","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do campo.","maxLength":160,"minLength":1,"x-nullable":true}},"required":["xTexto","xCampo"]},"CteSimpSefazObsFiscoSimp":{"type":"object","description":"Campo de uso livre do contribuinte.\r\nInformar o nome do campo no atributo xCampo e o conteúdo do campo no XTexto.","properties":{"xCampo":{"type":"string","description":"Identificação do campo.","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","description":"Conteúdo do campo.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTexto","xCampo"]},"CteSimpSefazEmitSimp":{"type":"object","description":"Identificação do Emitente do CT-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ do emitente.\r\nInformar zeros não significativos.\r\n\r\n***Obrigatório caso o emitente seja pessoa jurídica***.","x-nullable":true},"CPF":{"type":"string","description":"CPF do emitente.\r\nInformar zeros não significativos.\r\nUsar com série específica 920-969 para emitente pessoa física com inscrição estadual.\r\n\r\n***Obrigatorio caso o emitente seja pessoa física***.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual do Emitente.\r\nA IE do emitente somente ficará sem informação para o caso do Regime Especial da NFF (tpEmis=3).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"IEST":{"type":"string","description":"Inscrição Estadual do Substituto Tributário.","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou Nome do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"enderEmit":{"$ref":"#/definitions/CteSimpSefazEndeEmiSimp"},"CRT":{"type":"integer","description":"Código do Regime Tributário. Informar:\r\n* 1 - Simples Nacional;\r\n* 2 - Simples Nacional, excesso sublimite de receita bruta;\r\n* 3 - Regime Normal;\r\n* 4 - Simples Nacional - Microempreendedor Individual (MEI).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"CteSimpSefazEndeEmiSimp":{"type":"object","description":"Endereço do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","properties":{"xLgr":{"type":"string","description":"Logradouro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"fone":{"type":"string","description":"Telefone.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"CteSimpSefazTomaSimp":{"type":"object","description":"Identificação do tomador do serviço no CT-e.","properties":{"toma":{"type":"integer","description":"Tomador do Serviço.\r\nPreencher com:\r\n* 0 - Remetente\r\n* 1 - Expedidor\r\n* 2 - Recebedor\r\n* 3 - Destinatário\r\n* 4 - Terceiro","x-nullable":true},"indIEToma":{"type":"integer","description":"Indicador do papel do tomador na prestação do serviço:\r\n* 1 - Contribuinte ICMS\r\n* 2 - Contribuinte isento de inscrição\r\n* 9 - Não Contribuinte\r\nAplica-se ao tomador que for indicado no toma.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nEm caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.\r\nInformar a IE do tomador ou ISENTO se tomador é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o tomador não seja contribuinte do ICMS não informar o conteúdo.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome.","maxLength":60,"minLength":2,"x-nullable":true},"ISUF":{"type":"string","description":"Inscrição na SUFRAMA.\r\n(Obrigatório nas operações com as áreas com benefícios de incentivos fiscais sob controle da SUFRAMA).","x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"enderToma":{"$ref":"#/definitions/CteSimpSefazEnderecoSimp"},"email":{"type":"string","description":"Endereço de email.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["enderToma","xNome","indIEToma","toma"]},"CteSimpSefazEnderecoSimp":{"type":"object","description":"Dados do endereço.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":255,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).\r\nInformar 9999999 para operações com o exterior.","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\nInformar EXTERIOR para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar os zeros não significativos.","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true},"cPais":{"type":"string","description":"Código do país.\r\nUtilizar a tabela do BACEN.","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["UF","xMun","cMun","xBairro","nro","xLgr"]},"CteSimpSefazInfCargaSimp":{"type":"object","description":"Informações da Carga do CT-e.","properties":{"vCarga":{"type":"number","description":"Valor total da carga.","minimum":0,"x-nullable":true},"proPred":{"type":"string","description":"Produto predominante.\r\nInformar a descrição do produto predominante.","maxLength":60,"minLength":1,"x-nullable":true},"xOutCat":{"type":"string","description":"Outras características da carga.\r\n\"FRIA\", \"GRANEL\", \"REFRIGERADA\", \"Medidas: 12X12X12\".","maxLength":30,"minLength":1,"x-nullable":true},"infQ":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazInfQSimp"},"minItems":1},"vCargaAverb":{"type":"number","description":"Valor da Carga para efeito de averbação.\r\nNormalmente igual ao valor declarado da mercadoria, diferente por exemplo, quando a mercadoria transportada é isenta de tributos nacionais para exportação, onde é preciso averbar um valor maior, pois no caso de indenização, o valor a ser pago será maior.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}},"required":["infQ","proPred","vCarga"]},"CteSimpSefazInfQSimp":{"type":"object","description":"Informações de quantidades da Carga do CT-e.\r\nPara o Aéreo é obrigatório o preenchimento desse campo da seguinte forma.\r\n* 1 - Peso Bruto, sempre em quilogramas (obrigatório)\r\n* 2 - Peso Cubado\r\nsempre em quilogramas\r\n* 3 - Quantidade de volumes, sempre em unidades (obrigatório)\r\n* 4 - Cubagem, sempre em metros cúbicos (obrigatório apenas quando for impossível preencher as dimensões da(s) embalagem(ens) na tag xDime do leiaute do Aéreo)","properties":{"cUnid":{"type":"string","description":"Código da Unidade de Medida.\r\nPreencher com:\r\n* 00 - M3\r\n* 01 - KG\r\n* 02 - TON\r\n* 03 - UNIDADE\r\n* 04 - LITROS\r\n* 05 - MMBTU","x-nullable":true},"tpMed":{"type":"string","description":"Tipo da Medida.\r\nInformar com:\r\n* 00 - Cubagem da NF-e\r\n* 01 - Cubagem Aferida pelo Transportador\r\n* 02 - Peso Bruto da NF-e\r\n* 03 - Peso Bruto Aferido pelo Transportador\r\n* 04 - Peso Cubado\r\n* 05 - Peso Base do Cálculo do Frete\r\n* 06 - Peso para uso Operacional\r\n* 07 - Caixas\r\n* 08 - Paletes\r\n* 09 - Sacas\r\n* 10 - Containers\r\n* 11 - Rolos\r\n* 12 - Bombonas\r\n* 13 - Latas\r\n* 14 - Litragem\r\n* 15 - Milhão de BTU (British Thermal Units)\r\n* 99 - Outros","maxLength":2,"minLength":1,"x-nullable":true},"qCarga":{"type":"number","description":"Quantidade.","minimum":0,"x-nullable":true}},"required":["qCarga","tpMed","cUnid"]},"CteSimpSefazDetSimp":{"type":"object","description":"Detalhamento das entregas / prestações do CTe Simplificado.","properties":{"nItem":{"type":"integer","description":"Número identificador do item agrupador da prestação.","maximum":990,"minimum":1,"x-nullable":true},"cMunIni":{"type":"string","description":"Código do Município de início da prestação.\r\nUtilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.","x-nullable":true},"xMunIni":{"type":"string","description":"Nome do Município do início da prestação.\r\nInformar 'EXTERIOR' para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"cMunFim":{"type":"string","description":"Código do Município de término da prestação.\r\nUtilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.","x-nullable":true},"xMunFim":{"type":"string","description":"Nome do Município do término da prestação.\r\nInformar 'EXTERIOR' para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"vPrest":{"type":"number","description":"Valorl da Prestação do Serviço.\r\nPode conter zeros quando o CT-e for de complemento de ICMS.","minimum":0,"x-nullable":true},"vRec":{"type":"number","description":"Valor a Receber.","minimum":0,"x-nullable":true},"Comp":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazCompSimp"}},"infNFe":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazInfNFeSimp"}},"infDocAnt":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazInfDocAntSimp"}}},"required":["vRec","vPrest","xMunFim","cMunFim","xMunIni","cMunIni","nItem"]},"CteSimpSefazCompSimp":{"type":"object","description":"Componentes do Valor da Prestação.","properties":{"xNome":{"type":"string","description":"Nome do componente.\r\nExxemplos: FRETE PESO, FRETE VALOR, SEC/CAT, ADEME, AGENDAMENTO, etc.","maxLength":15,"minLength":1,"x-nullable":true},"vComp":{"type":"number","description":"Valor do componente.","minimum":0,"x-nullable":true}},"required":["vComp","xNome"]},"CteSimpSefazInfNFeSimp":{"type":"object","description":"Informações das NF-e.","properties":{"chNFe":{"type":"string","description":"Chave de acesso da NF-e.","x-nullable":true},"PIN":{"type":"string","description":"PIN SUFRAMA.\r\nPIN atribuído pela SUFRAMA para a operação.","maxLength":9,"minLength":2,"x-nullable":true},"dPrev":{"type":"string","format":"date","description":"Data prevista de entrega.\r\nFormato AAAA-MM-DD.","x-nullable":true},"infUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazUnidCargaSimp"}},"infUnidTransp":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazUnidadeTranspSimp"}}},"required":["chNFe"]},"CteSimpSefazUnidCargaSimp":{"type":"object","description":"Informações das Unidades de Carga (Containeres/ULD/Outros).\r\nDispositivo de carga utilizada (Unit Load Device - ULD) significa todo tipo de contêiner de carga, vagão, contêiner de avião, palete de aeronave com rede ou palete de aeronave com rede sobre um iglu.","properties":{"tpUnidCarga":{"type":"integer","description":"Tipo da Unidade de Carga.\r\n* 1 - Container\r\n* 2 - ULD\r\n* 3 - Pallet\r\n* 4 - Outros","x-nullable":true},"idUnidCarga":{"type":"string","description":"Identificação da Unidade de Carga.\r\nInformar a identificação da unidade de carga, por exemplo: número do container.","maxLength":20,"minLength":1,"x-nullable":true},"lacUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazLacUnidCargaSimp"}},"qtdRat":{"type":"number","description":"Quantidade rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["idUnidCarga","tpUnidCarga"]},"CteSimpSefazLacUnidCargaSimp":{"type":"object","description":"Lacres das Unidades de Carga.","properties":{"nLacre":{"type":"string","description":"Número do lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"CteSimpSefazUnidadeTranspSimp":{"type":"object","description":"Informações das Unidades de Transporte (Carreta/Reboque/Vagão).\r\nDeve ser preenchido com as informações das unidades de transporte utilizadas.","properties":{"tpUnidTransp":{"type":"integer","description":"Tipo da Unidade de Transporte.\r\n* 1 - Rodoviário Tração\r\n* 2 - Rodoviário Reboque\r\n* 3 - Navio\r\n* 4 - Balsa\r\n* 5 - Aeronave\r\n* 6 - Vagão\r\n* 7 - Outros","x-nullable":true},"idUnidTransp":{"type":"string","description":"Identificação da Unidade de Transporte.\r\nInformar a identificação conforme o tipo de unidade de transporte.\r\nPor exemplo: para rodoviário tração ou reboque deverá preencher com a placa do veículo.","maxLength":20,"minLength":1,"x-nullable":true},"lacUnidTransp":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazLacUnidTranspSimp"}},"infUnidCarga":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazUnidCargaSimp"}},"qtdRat":{"type":"number","description":"Quantidade rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["idUnidTransp","tpUnidTransp"]},"CteSimpSefazLacUnidTranspSimp":{"type":"object","description":"Lacres das Unidades de Transporte.","properties":{"nLacre":{"type":"string","description":"Número do lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"CteSimpSefazInfDocAntSimp":{"type":"object","description":"Documentos anteriores.","properties":{"chCTe":{"type":"string","description":"Chave de acesso do CT-e.","maxLength":44,"x-nullable":true},"tpPrest":{"type":"integer","description":"indica se a prestação é total ou parcial em relação as notas do documento anterior.\r\nPreencher com:\r\n* 1 - Total\r\n* 2 - Parcial","x-nullable":true},"infNFeTranspParcial":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazInfNFeTranspParcialSimp"}}},"required":["tpPrest","chCTe"]},"CteSimpSefazInfNFeTranspParcialSimp":{"type":"object","properties":{"chNFe":{"type":"string","description":"Chave de acesso da NF-e.\r\nInformando o tpPrest com “2 - Parcial” deve-se informar as chaves de acesso das NF-e que acobertam a carga transportada.","maxLength":44,"x-nullable":true}},"required":["chNFe"]},"CteSimpSefazInfModalSimp":{"type":"object","description":"Informações do modal.","properties":{"versaoModal":{"type":"string","description":"Versão do leiaute específico para o Modal.","x-nullable":true},"rodo":{"$ref":"#/definitions/CteSimpSefazRodoSimp"},"aereo":{"$ref":"#/definitions/CteSimpSefazAereoSimp"},"ferrov":{"$ref":"#/definitions/CteSimpSefazFerrovSimp"},"aquav":{"$ref":"#/definitions/CteSimpSefazAquavSimp"},"duto":{"$ref":"#/definitions/CteSimpSefazDutoSimp"},"multimodal":{"$ref":"#/definitions/CteSimpSefazMultimodalSimp"}},"required":["versaoModal"]},"CteSimpSefazRodoSimp":{"type":"object","description":"Informações do modal Rodoviário.","properties":{"RNTRC":{"type":"string","description":"Registro Nacional de Transportadores Rodoviários de Carga.\r\nRegistro obrigatório do emitente do CT-e junto à ANTT para exercer a atividade de transportador rodoviário de cargas por conta de terceiros e mediante remuneração.","x-nullable":true},"occ":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazOccSimp"},"maxItems":10}},"required":["RNTRC"]},"CteSimpSefazOccSimp":{"type":"object","description":"Ordens de Coleta associados.","properties":{"serie":{"type":"string","description":"Série da OCC.","maxLength":3,"minLength":1,"x-nullable":true},"nOcc":{"type":"integer","description":"Número da Ordem de coleta.","maximum":999999,"minimum":1,"x-nullable":true},"dEmi":{"type":"string","format":"date","description":"Data de emissão da ordem de coleta.\r\nFormato AAAA-MM-DD.","x-nullable":true},"emiOcc":{"$ref":"#/definitions/CteSimpSefazEmiOccSimp"}},"required":["dEmi","nOcc"]},"CteSimpSefazEmiOccSimp":{"type":"object","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar os zeros não significativos.","x-nullable":true},"cInt":{"type":"string","description":"Código interno de uso da transportadora.\r\nUso intermo das transportadoras.","maxLength":10,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","maxLength":14,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true}},"required":["UF","IE","CNPJ"]},"CteSimpSefazAereoSimp":{"type":"object","description":"Informações do modal Aéreo.","properties":{"nMinu":{"type":"integer","description":"Número da Minuta.\r\nDocumento que precede o CT-e, assinado pelo expedidor, espécie de pedido de serviço.","maximum":999999999,"minimum":0,"x-nullable":true},"nOCA":{"type":"string","description":"Número Operacional do Conhecimento Aéreo.\r\nRepresenta o número de controle comumente utilizado pelo conhecimento aéreo composto por uma sequência numérica de onze dígitos. Os três primeiros dígitos representam um código que os operadores de transporte aéreo associados à IATA possuem. Em seguida um número de série de sete dígitos determinados pelo operador de transporte aéreo. Para finalizar, um dígito verificador, que é um sistema de módulo sete imponderado o qual divide o número de série do conhecimento aéreo por sete e usa o resto como dígito de verificação.","x-nullable":true},"dPrevAereo":{"type":"string","format":"date","description":"Data prevista da entrega.\r\nFormato AAAA-MM-DD.","x-nullable":true},"natCarga":{"$ref":"#/definitions/CteSimpSefazNatCargaSimp"},"tarifa":{"$ref":"#/definitions/CteSimpSefazTarifaSimp"},"peri":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazPeriSimp"}}},"required":["tarifa","natCarga","dPrevAereo"]},"CteSimpSefazNatCargaSimp":{"type":"object","description":"Natureza da carga.","properties":{"xDime":{"type":"string","description":"Dimensão.\r\nFormato:1234X1234X1234 (cm). Esse campo deve sempre que possível ser preenchido. Entretanto, quando for impossível o preenchimento das dimensões, fica obrigatório o preenchimento da cubagem em metro cúbico do leiaute do CT-e da estrutura genérica (infQ).","maxLength":14,"minLength":5,"x-nullable":true},"cInfManu":{"type":"array","description":"Informações de manuseio.\r\n* 01 - certificado do expedidor para embarque de animal vivo\r\n* 02 - artigo perigoso conforme Declaração do Expedidor anexa\r\n* 03 - somente em aeronave cargueira\r\n* 04 - artigo perigoso - declaração do expedidor não requerida\r\n* 05 - artigo perigoso em quantidade isenta\r\n* 06 - gelo seco para refrigeração (especificar no campo observações a quantidade)\r\n* 07 - não restrito (especificar a Disposição Especial no campo observações)\r\n* 08 - artigo perigoso em carga consolidada (especificar a quantidade no campo observações)\r\n* 09 - autorização da autoridade governamental anexa (especificar no campo observações)\r\n* 10 - baterias de íons de lítio em conformidade com a Seção II da PI965 - CAO\r\n* 11 - baterias de íons de lítio em conformidade com a Seção II da PI966\r\n* 12 - baterias de íons de lítio em conformidade com a Seção II da PI967\r\n* 13 - baterias de metal lítio em conformidade com a Seção II da PI968 — CAO\r\n* 14 - baterias de metal lítio em conformidade com a Seção II da PI969\r\n* 15 - baterias de metal lítio em conformidade com a Seção II da PI970\r\n* 99 - outro (especificar no campo observações)","items":{"type":"string"}}}},"CteSimpSefazTarifaSimp":{"type":"object","description":"Informações de tarifa.","properties":{"CL":{"type":"string","description":"Classe.\r\nPreencher com:\r\n* M - Tarifa Mínima\r\n* G - Tarifa Geral\r\n* E - Tarifa Específica","maxLength":1,"x-nullable":true},"cTar":{"type":"string","description":"Código da Tarifa.\r\nDeverão ser incluídos os códigos de três dígitos, correspondentes à tarifa.","maxLength":4,"minLength":1,"x-nullable":true},"vTar":{"type":"number","description":"Valor da Tarifa.\r\nValor da tarifa por kg quando for o caso.","minimum":0,"x-nullable":true}},"required":["vTar","CL"]},"CteSimpSefazPeriSimp":{"type":"object","description":"Preenchido quando for  transporte de produtos classificados pela ONU como perigosos.\r\nO preenchimento desses campos não desobriga a empresa aérea de emitir os demais documentos que constam na legislação vigente.","properties":{"nONU":{"type":"string","description":"Número ONU/UN.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","x-nullable":true},"qTotEmb":{"type":"string","description":"Quantidade total de volumes contendo artigos perigosos.\r\nPreencher com o número de volumes (unidades) de artigos perigosos, ou seja, cada embalagem devidamente marcada e etiquetada (por ex.: número de caixas, de tambores, de bombonas, dentre outros). Não deve ser preenchido com o número de ULD, pallets ou containers.","maxLength":20,"minLength":1,"x-nullable":true},"infTotAP":{"$ref":"#/definitions/CteSimpSefazInfTotAPSimp"}},"required":["infTotAP","qTotEmb","nONU"]},"CteSimpSefazInfTotAPSimp":{"type":"object","description":"Grupo de informações das quantidades totais de artigos perigosos.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","properties":{"qTotProd":{"type":"number","description":"Quantidade total de artigos perigosos.\r\n15 posições, sendo 11 inteiras e 4 decimais.\r\nDeve indicar a quantidade total do artigo perigoso, tendo como base a unidade referenciada na Tabela 3-1 do Doc 9284, por exemplo: litros\r\nquilogramas\r\nquilograma bruto etc. O preenchimento não deve, entretanto, incluir a unidade de medida. No caso de transporte de material radioativo, deve-se indicar o somatório dos Índices de Transporte (TI). Não indicar a quantidade do artigo perigoso por embalagem.","minimum":0,"x-nullable":true},"uniAP":{"type":"integer","description":"Unidade de medida.\r\n* 1 - KG\r\n* 2 - KG G (quilograma bruto)\r\n* 3 - LITROS\r\n* 4 - TI (índice de transporte para radioativos)\r\n* 5 - Unidades (apenas para artigos perigosos medidos em unidades que não se enquadram nos itens acima. Exemplo: baterias, celulares, equipamentos, veículos, dentre outros)","x-nullable":true}},"required":["uniAP","qTotProd"]},"CteSimpSefazFerrovSimp":{"type":"object","description":"Informações do modal Ferroviário.","properties":{"tpTraf":{"type":"integer","description":"Tipo de Tráfego.\r\nPreencher com:\r\n* 0 - Próprio\r\n* 1 - Mútuo\r\n* 2 - Rodoferroviário\r\n* 3 - Rodoviário","x-nullable":true},"trafMut":{"$ref":"#/definitions/CteSimpSefazTrafMutSimp"},"fluxo":{"type":"string","description":"Fluxo Ferroviário.\r\nTrata-se de um número identificador do contrato firmado com o cliente.","maxLength":10,"minLength":1,"x-nullable":true}},"required":["fluxo","tpTraf"]},"CteSimpSefazTrafMutSimp":{"type":"object","description":"Detalhamento de informações para o tráfego mútuo.","properties":{"respFat":{"type":"integer","description":"Responsável pelo Faturamento.\r\nPreencher com:\r\n* 1 - Ferrovia de origem\r\n* 2 - Ferrovia de destino","x-nullable":true},"ferrEmi":{"type":"integer","description":"Ferrovia Emitente do CTe.\r\nPreencher com:\r\n* 1 - Ferrovia de origem\r\n* 2 - Ferrovia de destino","x-nullable":true},"vFrete":{"type":"number","description":"Valor do Frete do Tráfego Mútuo.","minimum":0,"x-nullable":true},"chCTeFerroOrigem":{"type":"string","description":"Chave de acesso do CT-e emitido pelo ferrovia de origem.","maxLength":44,"x-nullable":true},"ferroEnv":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazFerroEnvSimp"}}},"required":["vFrete","ferrEmi","respFat"]},"CteSimpSefazFerroEnvSimp":{"type":"object","description":"Informações das Ferrovias Envolvidas.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar o CNPJ da Ferrovia Envolvida. Caso a Ferrovia envolvida não seja inscrita no CNPJ o campo deverá preenchido com zeros.\r\nInformar os zeros não significativos.","x-nullable":true},"cInt":{"type":"string","description":"Código interno da Ferrovia envolvida.\r\nUso da transportadora.","maxLength":10,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","maxLength":14,"x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome.","maxLength":60,"minLength":2,"x-nullable":true},"enderFerro":{"$ref":"#/definitions/CteSimpSefazEnderFerSimp"}},"required":["enderFerro","xNome","CNPJ"]},"CteSimpSefazEnderFerSimp":{"type":"object","description":"Dados do endereço da ferrovia envolvida.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":255,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município.\r\nUtilizar a tabela do IBGE\r\nInformar 9999999 para operações com o exterior.","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\nInformar EXTERIOR para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\nInformar EX para operações com o exterior.","x-nullable":true}},"required":["UF","CEP","xMun","cMun","xLgr"]},"CteSimpSefazAquavSimp":{"type":"object","description":"Informações do modal Aquaviário.","properties":{"vPrest":{"type":"number","description":"Valor da Prestação Base de Cálculo do AFRMM.","minimum":0,"x-nullable":true},"vAFRMM":{"type":"number","description":"AFRMM (Adicional de Frete para Renovação da Marinha Mercante).","minimum":0,"x-nullable":true},"xNavio":{"type":"string","description":"Identificação do Navio.","maxLength":60,"minLength":1,"x-nullable":true},"balsa":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazBalsaSimp"},"maxItems":3},"nViag":{"type":"string","description":"Número da Viagem.","x-nullable":true},"direc":{"type":"string","description":"Direção.\r\nPreencher com: N-Norte, L-Leste, S-Sul, O-Oeste.","x-nullable":true},"irin":{"type":"string","description":"Irin do navio sempre deverá ser informado.","maxLength":10,"minLength":1,"x-nullable":true},"detCont":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazDetContSimp"}},"tpNav":{"type":"integer","description":"Tipo de Navegação.\r\nPreencher com:\r\n* 0 - Interior\r\n* 1 - Cabotagem","x-nullable":true}},"required":["irin","direc","xNavio","vAFRMM","vPrest"]},"CteSimpSefazBalsaSimp":{"type":"object","description":"Grupo de informações das balsas.","properties":{"xBalsa":{"type":"string","description":"Identificador da Balsa.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xBalsa"]},"CteSimpSefazDetContSimp":{"type":"object","description":"Grupo de informações de detalhamento dos conteiners\r\n(Somente para Redespacho Intermediário e Serviço Vinculado a Multimodal).","properties":{"nCont":{"type":"string","description":"Identificação do Container.","maxLength":20,"minLength":1,"x-nullable":true},"lacre":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazLacreSimp"},"maxItems":3},"infDoc":{"$ref":"#/definitions/CteSimpSefazInfDocSimp"}},"required":["nCont"]},"CteSimpSefazLacreSimp":{"type":"object","description":"Grupo de informações dos lacres dos cointainers da qtde da carga.","properties":{"nLacre":{"type":"string","description":"Lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"CteSimpSefazInfDocSimp":{"type":"object","description":"Informações dos documentos dos conteiners.","properties":{"infNF":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazInfNFSimp"}},"infNFe":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazInfDoc_InfNFeSimp"}}}},"CteSimpSefazInfNFSimp":{"type":"object","description":"Informações das NF.","properties":{"serie":{"type":"string","description":"Série.","maxLength":3,"minLength":1,"x-nullable":true},"nDoc":{"type":"string","description":"Número.","maxLength":20,"minLength":1,"x-nullable":true},"unidRat":{"type":"number","description":"Unidade de medida rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["nDoc","serie"]},"CteSimpSefazInfDoc_InfNFeSimp":{"type":"object","description":"Informações das NFe.","properties":{"chave":{"type":"string","description":"Chave de acesso da NF-e.","maxLength":44,"x-nullable":true},"unidRat":{"type":"number","description":"Unidade de medida rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["chave"]},"CteSimpSefazDutoSimp":{"type":"object","description":"Informações do modal Dutoviário.","properties":{"vTar":{"type":"number","description":"Valor da tarifa.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"dIni":{"type":"string","format":"date","description":"Data de Início da prestação do serviço.","x-nullable":true},"dFim":{"type":"string","format":"date","description":"Data de Fim da prestação do serviço.","x-nullable":true},"classDuto":{"type":"integer","description":"Classificação do Dutoviário.\r\nInformar: 1 - Gasoduto 2 - Mineroduto 3 - Oleoduto.","x-nullable":true},"tpContratacao":{"type":"integer","description":"Tipo de contratação do serviço de transporte (apenas para gasoduto).\r\nInformar:\r\n* 0 - Ponta a ponto\r\n* 1 - Capacidade de Entrada\r\n* 2 - Capacidade de Saida","x-nullable":true},"codPontoEntrada":{"type":"string","description":"Código do Ponto de Entrada.","maxLength":20,"minLength":2,"x-nullable":true},"codPontoSaida":{"type":"string","description":"Código do Ponto de Saída.","maxLength":20,"minLength":2,"x-nullable":true},"nContrato":{"type":"string","description":"Número do Contrato de Capacidade.","maxLength":20,"minLength":2,"x-nullable":true}},"required":["dFim","dIni"]},"CteSimpSefazMultimodalSimp":{"type":"object","description":"Informações do Multimodal.","properties":{"COTM":{"type":"string","description":"Número do Certificado do Operador de Transporte Multimodal.","maxLength":20,"minLength":1,"x-nullable":true},"indNegociavel":{"type":"integer","description":"Indicador Negociável\r\nPreencher com: 0 - Não Negociável\r\n* 1 - Negociável","x-nullable":true},"seg":{"$ref":"#/definitions/CteSimpSefazSegSimp"}},"required":["indNegociavel","COTM"]},"CteSimpSefazSegSimp":{"type":"object","description":"Informações de Seguro do Multimodal.","properties":{"infSeg":{"$ref":"#/definitions/CteSimpSefazInfSegSimp"},"nApol":{"type":"string","description":"Número da Apólice.\r\nObrigatório pela lei 11.442/07 (RCTRC).","maxLength":20,"minLength":1,"x-nullable":true},"nAver":{"type":"string","description":"Número da Averbação.\r\nNão é obrigatório, pois muitas averbações ocorrem aapós a emissão do CT, mensalmente, por exemplo.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nAver","nApol","infSeg"]},"CteSimpSefazInfSegSimp":{"type":"object","description":"Informações da seguradora.","properties":{"xSeg":{"type":"string","description":"Nome da Seguradora.","maxLength":30,"minLength":1,"x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ da seguradora.\r\nObrigatório apenas se responsável pelo seguro for (2) responsável pela contratação do transporte - pessoa jurídica.","x-nullable":true}},"required":["CNPJ","xSeg"]},"CteSimpSefazCobrSimp":{"type":"object","description":"Dados da cobrança do CT-e.","properties":{"fat":{"$ref":"#/definitions/CteSimpSefazFatSimp"},"dup":{"type":"array","items":{"$ref":"#/definitions/CteSimpSefazDupSimp"}}}},"CteSimpSefazFatSimp":{"type":"object","description":"Dados da fatura.","properties":{"nFat":{"type":"string","description":"Número da fatura.","maxLength":60,"minLength":1,"x-nullable":true},"vOrig":{"type":"number","description":"Valor original da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDesc":{"type":"number","description":"Valor do desconto da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vLiq":{"type":"number","description":"Valor líquido da fatura.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}}},"CteSimpSefazDupSimp":{"type":"object","description":"Dados das duplicatas.","properties":{"nDup":{"type":"string","description":"Número da duplicata.","maxLength":60,"minLength":1,"x-nullable":true},"dVenc":{"type":"string","format":"date","description":"Data de vencimento da duplicata (AAAA-MM-DD).","x-nullable":true},"vDup":{"type":"number","description":"Valor da duplicata.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}}},"CteSimpSefazInfCteSubSimp":{"type":"object","description":"Informações do CT-e de substituição.","properties":{"chCte":{"type":"string","description":"Chave de acesso do CT-e a ser substituído (original).","x-nullable":true},"indAlteraToma":{"type":"integer","description":"Indicador de CT-e Alteração de Tomador.","x-nullable":true}},"required":["chCte"]},"CteSimpSefazInfCte_ImpSimp":{"type":"object","description":"Informações relativas aos Impostos.","properties":{"ICMS":{"$ref":"#/definitions/CteSimpSefazImpSimp"},"vTotTrib":{"type":"number","description":"Valor Total dos Tributos.","minimum":0,"x-nullable":true},"infAdFisco":{"type":"string","description":"Informações adicionais de interesse do Fisco.\r\nNorma referenciada, informações complementares, etc.","maxLength":2000,"minLength":1,"x-nullable":true},"ICMSUFFim":{"$ref":"#/definitions/CteSimpSefazICMSUFFimSimp"},"IBSCBS":{"$ref":"#/definitions/CteSimpSefazTribCTeSimp"}},"required":["ICMS"]},"CteSimpSefazImpSimp":{"type":"object","description":"Informações relativas ao ICMS.","properties":{"ICMS00":{"$ref":"#/definitions/CteSimpSefazICMS00Simp"},"ICMS20":{"$ref":"#/definitions/CteSimpSefazICMS20Simp"},"ICMS45":{"$ref":"#/definitions/CteSimpSefazICMS45Simp"},"ICMS60":{"$ref":"#/definitions/CteSimpSefazICMS60Simp"},"ICMS90":{"$ref":"#/definitions/CteSimpSefazICMS90Simp"},"ICMSOutraUF":{"$ref":"#/definitions/CteSimpSefazICMSOutraUFSimp"},"ICMSSN":{"$ref":"#/definitions/CteSimpSefazICMSSNSimp"}}},"CteSimpSefazICMS00Simp":{"type":"object","description":"Prestação sujeito à tributação normal do ICMS.","properties":{"CST":{"type":"string","description":"classificação Tributária do Serviço.\r\n* 00 - tributação normal ICMS","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true}},"required":["vICMS","pICMS","vBC","CST"]},"CteSimpSefazICMS20Simp":{"type":"object","description":"Prestação sujeito à tributação com redução de BC do ICMS.","properties":{"CST":{"type":"string","description":"Classificação Tributária do serviço.\r\n* 20 - tributação com BC reduzida do ICMS","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMS","pICMS","vBC","pRedBC","CST"]},"CteSimpSefazICMS45Simp":{"type":"object","description":"ICMS  Isento, não Tributado ou diferido.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\nPreencher com:\r\n* 40 - ICMS isenção\r\n* 41 - ICMS não tributada\r\n* 51 - ICMS diferido","x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["CST"]},"CteSimpSefazICMS60Simp":{"type":"object","description":"Tributação pelo ICMS60 - ICMS cobrado por substituição tributária.Responsabilidade do recolhimento do ICMS atribuído ao tomador ou 3º por ST.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 60 - ICMS cobrado por substituição tributária","x-nullable":true},"vBCSTRet":{"type":"number","description":"Valor da BC do ICMS ST retido.\r\nValor do frete sobre o qual será calculado o ICMS a ser substituído na Prestação.","minimum":0,"x-nullable":true},"vICMSSTRet":{"type":"number","description":"Valor do ICMS ST retido.\r\nResultado da multiplicação do “vBCSTRet” x “pICMSSTRet” - que será valor do ICMS a ser retido pelo Substituto. Podendo o valor do ICMS a ser retido efetivamente, sofrer ajustes conforme a opção tributaria do transportador substituído.","minimum":0,"x-nullable":true},"pICMSSTRet":{"type":"number","description":"Alíquota do ICMS.\r\nPercentual de Alíquota incidente na prestação de serviço de transporte.","minimum":0,"x-nullable":true},"vCred":{"type":"number","description":"Valor do Crédito outorgado/Presumido.\r\nPreencher somente quando o transportador substituído, for optante pelo crédito outorgado previsto no Convênio 106/96 e corresponde ao percentual de 20%% do valor do ICMS ST retido.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["pICMSSTRet","vICMSSTRet","vBCSTRet","CST"]},"CteSimpSefazICMS90Simp":{"type":"object","description":"ICMS Outros.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS outros","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vCred":{"type":"number","description":"Valor do Crédito Outorgado/Presumido.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMS","pICMS","vBC","CST"]},"CteSimpSefazICMSOutraUFSimp":{"type":"object","description":"ICMS devido à UF de origem da prestação, quando  diferente da UF do emitente.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS Outra UF","x-nullable":true},"pRedBCOutraUF":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBCOutraUF":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMSOutraUF":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMSOutraUF":{"type":"number","description":"Valor do ICMS devido outra UF.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"cBenef":{"type":"string","description":"Código de Benefício Fiscal na UF.\r\nCódigo de Benefício Fiscal utilizado pela UF.","maxLength":10,"x-nullable":true}},"required":["vICMSOutraUF","pICMSOutraUF","vBCOutraUF","CST"]},"CteSimpSefazICMSSNSimp":{"type":"object","description":"Simples Nacional.","properties":{"CST":{"type":"string","description":"Classificação Tributária do Serviço.\r\n* 90 - ICMS Simples Nacional","x-nullable":true},"indSN":{"type":"integer","description":"Indica se o contribuinte é Simples Nacional\t\t\t1=Sim.","x-nullable":true}},"required":["indSN","CST"]},"CteSimpSefazICMSUFFimSimp":{"type":"object","description":"Informações do ICMS de partilha com a UF de término do serviço de transporte na operação interestadual.\r\nGrupo a ser informado nas prestações interestaduais para consumidor final, não contribuinte do ICMS.","properties":{"vBCUFFim":{"type":"number","description":"Valor da BC do ICMS na UF de término da prestação do serviço de transporte.","minimum":0,"x-nullable":true},"pFCPUFFim":{"type":"number","description":"Percentual do ICMS relativo ao Fundo de Combate à pobreza (FCP) na UF de término da prestação do serviço de transporte.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"pICMSUFFim":{"type":"number","description":"Alíquota interna da UF de término da prestação do serviço de transporte.\r\nAlíquota adotada nas operações internas na UF do destinatário.","minimum":0,"x-nullable":true},"pICMSInter":{"type":"number","description":"Alíquota interestadual das UF envolvidas.\r\nAlíquota interestadual das UF envolvidas.","minimum":0,"x-nullable":true},"vFCPUFFim":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate á Pobreza (FCP) da UF de término da prestação.","minimum":0,"x-nullable":true},"vICMSUFFim":{"type":"number","description":"Valor do ICMS de partilha para a UF de término da prestação do serviço de transporte.","minimum":0,"x-nullable":true},"vICMSUFIni":{"type":"number","description":"Valor do ICMS de partilha para a UF de início da prestação do serviço de transporte.","minimum":0,"x-nullable":true}},"required":["vICMSUFIni","vICMSUFFim","vFCPUFFim","pICMSInter","pICMSUFFim","pFCPUFFim","vBCUFFim"]},"CteSimpSefazTribCTeSimp":{"type":"object","description":"Grupo de informações do IBS e CBS.","properties":{"CST":{"type":"string","description":"Código Situação Tributária do IBS/CBS.","x-nullable":true},"cClassTrib":{"type":"string","x-nullable":true},"indDoacao":{"type":"integer","x-nullable":true},"gIBSCBS":{"$ref":"#/definitions/CteSimpSefazCIBSSimp"},"gEstornoCred":{"$ref":"#/definitions/CteSimpSefazEstornoCredSimp"}},"required":["CST"]},"CteSimpSefazCIBSSimp":{"type":"object","properties":{"vBC":{"type":"number","description":"Valor do BC.","minimum":0,"x-nullable":true},"gIBSUF":{"$ref":"#/definitions/CteSimpSefazGIBSUFSimp"},"gIBSMun":{"$ref":"#/definitions/CteSimpSefazGIBSMunSimp"},"vIBS":{"type":"number","description":"Valor do IBS.","minimum":0,"x-nullable":true},"gCBS":{"$ref":"#/definitions/CteSimpSefazGCBSSimp"},"gTribRegular":{"$ref":"#/definitions/CteSimpSefazTribRegularSimp"},"gTribCompraGov":{"$ref":"#/definitions/CteSimpSefazTribCompraGovSimp"}},"required":["gCBS","vIBS","gIBSMun","gIBSUF","vBC"]},"CteSimpSefazGIBSUFSimp":{"type":"object","description":"Grupo de informações do IBS na UF.","properties":{"pIBSUF":{"type":"number","description":"Aliquota do IBS de competência das UF (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteSimpSefazDifSimp"},"gDevTrib":{"$ref":"#/definitions/CteSimpSefazDevTribSimp"},"gRed":{"$ref":"#/definitions/CteSimpSefazRedSimp"},"vIBSUF":{"type":"number","description":"Valor do IBS de competência das UF.","minimum":0,"x-nullable":true}},"required":["vIBSUF","pIBSUF"]},"CteSimpSefazDifSimp":{"type":"object","description":"Grupo de campos do Diferimento.","properties":{"pDif":{"type":"number","description":"Percentual do diferimento.","minimum":0,"x-nullable":true},"vDif":{"type":"number","description":"Valor do diferimento.","minimum":0,"x-nullable":true}},"required":["vDif","pDif"]},"CteSimpSefazDevTribSimp":{"type":"object","description":"Grupo de Informações da devolução de tributos.","properties":{"vDevTrib":{"type":"number","description":"Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e\r\ngás natural e em outras hipóteses definidas no regulamento.","minimum":0,"x-nullable":true}},"required":["vDevTrib"]},"CteSimpSefazRedSimp":{"type":"object","description":"Grupo de campos da redução de aliquota.","properties":{"pRedAliq":{"type":"number","description":"Percentual de redução de aliquota do cClassTrib.","minimum":0,"x-nullable":true},"pAliqEfet":{"type":"number","description":"Aliquota Efetiva que será aplicada a Base de Calculo (em percentual).","minimum":0,"x-nullable":true}},"required":["pAliqEfet","pRedAliq"]},"CteSimpSefazGIBSMunSimp":{"type":"object","description":"Grupo de Informações do IBS no Município.","properties":{"pIBSMun":{"type":"number","description":"Aliquota do IBS Municipal (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteSimpSefazDifSimp"},"gDevTrib":{"$ref":"#/definitions/CteSimpSefazDevTribSimp"},"gRed":{"$ref":"#/definitions/CteSimpSefazRedSimp"},"vIBSMun":{"type":"number","description":"Valor do IBS Municipal.","minimum":0,"x-nullable":true}},"required":["vIBSMun","pIBSMun"]},"CteSimpSefazGCBSSimp":{"type":"object","description":"Grupo de Tributação da CBS.","properties":{"pCBS":{"type":"number","description":"Aliquota da CBS (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/CteSimpSefazDifSimp"},"gDevTrib":{"$ref":"#/definitions/CteSimpSefazDevTribSimp"},"gRed":{"$ref":"#/definitions/CteSimpSefazRedSimp"},"vCBS":{"type":"number","description":"Valor da CBS.","minimum":0,"x-nullable":true}},"required":["vCBS","pCBS"]},"CteSimpSefazTribRegularSimp":{"type":"object","description":"Grupo de informações da Tributação Regular. Informar como seria a tributação caso não cumprida a condição resolutória/suspensiva. Exemplo 1: Art. 442, §4. Operações com ZFM e ALC. Exemplo 2: Operações com suspensão do tributo.","properties":{"CSTReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS.\r\nInformar qual seria o CST caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"cClassTribReg":{"type":"string","description":"Informar qual seria o cClassTrib caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"pAliqEfetRegIBSUF":{"type":"number","description":"Alíquota do IBS da UF.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSUF":{"type":"number","description":"Valor do IBS da UF.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegIBSMun":{"type":"number","description":"Alíquota do IBS do Município.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSMun":{"type":"number","description":"Valor do IBS do Município.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegCBS":{"type":"number","description":"Alíquota da CBS.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegCBS":{"type":"number","description":"Valor da CBS.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true}},"required":["vTribRegCBS","pAliqEfetRegCBS","vTribRegIBSMun","pAliqEfetRegIBSMun","vTribRegIBSUF","pAliqEfetRegIBSUF","cClassTribReg","CSTReg"]},"CteSimpSefazTribCompraGovSimp":{"type":"object","description":"Grupo de informações da composição do valor do IBS e da CBS em compras governamental.","properties":{"pAliqIBSUF":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSUF":{"type":"number","description":"Valor que seria devido a UF, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqIBSMun":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSMun":{"type":"number","description":"Valor que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqCBS":{"type":"number","minimum":0,"x-nullable":true},"vTribCBS":{"type":"number","description":"Valor que seria devido a CBS, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true}},"required":["vTribCBS","vTribIBSMun","vTribIBSUF"]},"CteSimpSefazEstornoCredSimp":{"type":"object","description":"Informado conforme indicador no cClassTrib.","properties":{"vIBSEstCred":{"type":"number","description":"Valor do IBS a ser estornado.","minimum":0,"x-nullable":true},"vCBSEstCred":{"type":"number","description":"Valor da CBS a ser estornada.","minimum":0,"x-nullable":true}},"required":["vCBSEstCred","vIBSEstCred"]},"CteSimpSefazTotalSimp":{"type":"object","description":"Valores Totais do CTe.","properties":{"vTPrest":{"type":"number","description":"Valor Total da Prestação do Serviço.\r\nPode conter zeros quando o CT-e for de complemento de ICMS.","minimum":0,"x-nullable":true},"vTRec":{"type":"number","description":"Valor total a Receber.","minimum":0,"x-nullable":true},"vTotDFe":{"type":"number","description":"Valor total do documento fiscal\r\n(vTPrest + total do IBS + total da CBS).","minimum":0,"x-nullable":true}},"required":["vTRec","vTPrest"]},"CteSimpSefazAutXMLSimp":{"type":"object","description":"Autorizados para download do XML do DF-e.\r\nInformar CNPJ ou CPF. Preencher os zeros não significativos.","properties":{"CNPJ":{"type":"string","description":"CNPJ do autorizado.\r\nInformar zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"CPF do autorizado.\r\nInformar zeros não significativos.","x-nullable":true}}},"CteSimpSefazRespTecSimp":{"type":"object","description":"Informações do Responsável Técnico pela emissão do DF-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ da pessoa jurídica responsável técnica pelo sistema utilizado na emissão do documento fiscal eletrônico.\r\nInformar o CNPJ da pessoa jurídica desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico.","x-nullable":true},"xContato":{"type":"string","description":"Nome da pessoa a ser contatada.\r\nInformar o nome da pessoa a ser contatada na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico. No caso de pessoa física, informar o respectivo nome.","maxLength":60,"minLength":2,"x-nullable":true},"email":{"type":"string","description":"Email da pessoa jurídica a ser contatada.","maxLength":60,"minLength":1,"x-nullable":true},"fone":{"type":"string","description":"Telefone da pessoa jurídica a ser contatada.\r\nPreencher com o Código DDD + número do telefone.","x-nullable":true},"idCSRT":{"type":"integer","description":"Identificador do código de segurança do responsável técnico.\r\nIdentificador do CSRT utilizado para geração do hash.","maximum":999,"minimum":0,"x-nullable":true},"CSRT":{"type":"string","description":"Código de Segurança do Responsável Técnico utilizado para montar o hash do CSRT.","x-nullable":true},"hashCSRT":{"type":"string","description":"Hash do token do código de segurança do responsável técnico.\r\nO hashCSRT é o resultado das funções SHA-1 e base64 do token CSRT fornecido pelo fisco + chave de acesso do DF-e. (Implementação em futura NT)\r\nObservação: 28 caracteres são representados no schema como 20 bytes do tipo base64Binary.\r\n\r\n*Se não informado, será calculado automaticamente, desde que os campos `idCSRT` e `CSRT` sejam fornecidos.*","maxLength":28,"x-nullable":true}},"required":["fone","email","xContato","CNPJ"]},"CteSimpSefazInfSolicNFFSimp":{"type":"object","description":"Grupo de informações do pedido de emissão da Nota Fiscal Fácil.","properties":{"xSolic":{"type":"string","description":"Solicitação do pedido de emissão da NFF.\r\nSerá preenchido com a totalidade de campos informados no aplicativo emissor serializado.","maxLength":8000,"minLength":2,"x-nullable":true}},"required":["xSolic"]},"CteSimpSefazInfCTeSuplSimp":{"type":"object","description":"Informações suplementares do CT-e.","properties":{"qrCodCTe":{"type":"string","description":"Texto com o QR-Code impresso no DACTE.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":1000,"minLength":50,"x-nullable":true}}},"CtePedidoCancelamento":{"type":"object","properties":{"justificativa":{"type":"string","description":"Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco."}}},"CtePedidoCartaCorrecao":{"type":"object","properties":{"correcoes":{"type":"array","description":"Grupo de Informações de Correção.","items":{"$ref":"#/definitions/CteInfCorrecao"},"minItems":1}},"required":["correcoes"]},"CteInfCorrecao":{"type":"object","properties":{"grupo_alterado":{"type":"string","description":"Indicar o grupo de informações que pertence o \"campo_alterado\". Ex: ide.","maxLength":20,"minLength":1},"campo_alterado":{"type":"string","description":"Nome do campo modificado do CT-e Original.","maxLength":20,"minLength":1},"valor_alterado":{"type":"string","description":"Valor correspondente à alteração.","maxLength":500,"minLength":1},"numero_item_alterado":{"type":"integer","description":"Preencher com o indice do item alterado caso a alteração ocorra em uma lista.\r\nOBS: O indice inicia sempre em 1.","x-nullable":true}},"required":["valor_alterado","campo_alterado","grupo_alterado"]},"CteCartaCorrecao":{"type":"object","properties":{"correcoes":{"type":"array","description":"Grupo de Informações de Correção.","items":{"$ref":"#/definitions/CteInfCorrecao"},"minItems":1},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}},"required":["correcoes"]},"MdfeNaoEncerrados":{"type":"object","properties":{"tpAmb":{"type":"integer","description":"Identificação do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"verAplic":{"type":"string","description":"Versão do Aplicativo que processou o MDF-e.","x-nullable":true},"cStat":{"type":"integer","description":"Código do status da mensagem enviada.","x-nullable":true},"xMotivo":{"type":"string","description":"Descrição literal do status do serviço solicitado.","x-nullable":true},"cUF":{"type":"integer","description":"código da UF de atendimento.","x-nullable":true},"infMDFe":{"type":"array","items":{"$ref":"#/definitions/MdfeNaoEncerrado"}}},"required":["cStat"]},"MdfeNaoEncerrado":{"type":"object","properties":{"chMDFe":{"type":"string","description":"Chaves de acesso do MDF-e não encerrado.","x-nullable":true},"nProt":{"type":"string","description":"Número do Protocolo de autorização do MDF-e não encerrado.","x-nullable":true}},"required":["nProt","chMDFe"]},"MdfePedidoEmissaoLote":{"type":"object","properties":{"documentos":{"type":"array","items":{"$ref":"#/definitions/MdfePedidoEmissao"},"maxItems":1,"minItems":1},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50},"id_lote":{"type":"string"}},"required":["id_lote","ambiente"]},"MdfePedidoEmissao":{"type":"object","properties":{"infMDFe":{"$ref":"#/definitions/MdfeSefazInfMDFe"},"infMDFeSupl":{"$ref":"#/definitions/MdfeSefazInfMDFeSupl"},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true}},"required":["ambiente","infMDFe"]},"MdfeSefazInfMDFe":{"type":"object","description":"Informações do MDF-e.","properties":{"versao":{"type":"string","description":"Versão do leiaute.\r\nEx: \"3.00\".","x-nullable":true},"Id":{"type":"string","description":"Identificador da tag a ser assinada.\r\nInformar a chave de acesso do MDF-e e precedida do literal \"MDFe\".\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"ide":{"$ref":"#/definitions/MdfeSefazIde"},"emit":{"$ref":"#/definitions/MdfeSefazEmit"},"infModal":{"$ref":"#/definitions/MdfeSefazInfModal"},"infDoc":{"$ref":"#/definitions/MdfeSefazInfDoc"},"seg":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazSeg"}},"prodPred":{"$ref":"#/definitions/MdfeSefazProdPred"},"tot":{"$ref":"#/definitions/MdfeSefazTot"},"lacres":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazLacres"}},"autXML":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazAutXML"},"maxItems":10},"infAdic":{"$ref":"#/definitions/MdfeSefazInfAdic"},"infRespTec":{"$ref":"#/definitions/MdfeSefazRespTec"},"infSolicNFF":{"$ref":"#/definitions/MdfeSefazInfSolicNFF"}},"required":["tot","infDoc","infModal","emit","ide","versao"]},"MdfeSefazIde":{"type":"object","description":"Identificação do MDF-e.","properties":{"cUF":{"type":"integer","description":"Código da UF do emitente do MDF-e.\r\nCódigo da UF do emitente do Documento Fiscal. Utilizar a\r\nTabela do IBGE de código de unidades da federação.","x-nullable":true},"tpAmb":{"type":"integer","description":"Tipo do Ambiente.\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"tpEmit":{"type":"integer","description":"Tipo do Emitente.\r\n* 1 - Prestador de serviço de transporte\r\n* 2 - Transportador de Carga Própria 3 - Prestador de serviço de transporte que emitirá CT-e Globalizado\r\nOBS: Deve ser preenchido com 2 para emitentes de NF-e e pelas transportadoras quando estiverem fazendo transporte de carga própria. Deve ser preenchido com 3 para transportador de carga que emitirá à posteriori CT-e Globalizado relacionando as NF-e.","x-nullable":true},"tpTransp":{"type":"integer","description":"Tipo do Transportador.\r\n* 1 - ETC\r\n* 2 - TAC\r\n* 3 - CTC","x-nullable":true},"mod":{"type":"integer","description":"Modelo do Manifesto Eletrônico.\r\nUtilizar o código 58 para identificação do MDF-e.","x-nullable":true},"serie":{"type":"integer","description":"Série do Manifesto.\r\nInformar a série do documento fiscal (informar zero se inexistente).\r\nSérie na faixa [920-969]: Reservada para emissão por contribuinte pessoa física com inscrição estadual.","maximum":999,"minimum":0,"x-nullable":true},"nMDF":{"type":"integer","description":"Número do Manifesto.\r\nNúmero que identifica o Manifesto. 1 a 999999999.","maximum":999999999,"minimum":1,"x-nullable":true},"cMDF":{"type":"string","description":"Código numérico que compõe a Chave de Acesso.\r\nCódigo aleatório gerado pelo emitente, com o objetivo de evitar acessos indevidos ao documento.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"cDV":{"type":"integer","description":"Digito verificador da chave de acesso do Manifesto.\r\nInformar o dígito  de controle da chave de acesso do MDF-e, que deve ser calculado com a aplicação do algoritmo módulo 11 (base 2,9) da chave de acesso.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maximum":9,"minimum":0,"x-nullable":true},"modal":{"type":"integer","description":"Modalidade de transporte.\r\n* 1 - Rodoviário\r\n* 2 - Aéreo\r\n* 3 - Aquaviário\r\n* 4 - Ferroviário","x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e hora de emissão do Manifesto.\r\nFormato AAAA-MM-DDTHH:MM:DD TZD.","x-nullable":true},"tpEmis":{"type":"integer","description":"Forma de emissão do Manifesto.\r\n* 1 - Normal\r\n* 2 - Contingência\r\n* 3 - Regime Especial NFF","x-nullable":true},"procEmi":{"type":"string","description":"Identificação do processo de emissão do Manifesto.\r\n* 0 - emissão de MDF-e com aplicativo do contribuinte","x-nullable":true},"verProc":{"type":"string","description":"Versão do processo de emissão.\r\nInformar a versão do aplicativo emissor de MDF-e.","maxLength":20,"minLength":1,"x-nullable":true},"UFIni":{"type":"string","description":"Sigla da UF do Carregamento.\r\nUtilizar a Tabela do IBGE de código de unidades da federação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"UFFim":{"type":"string","description":"Sigla da UF do Descarregamento.\r\nUtilizar a Tabela do IBGE de código de unidades da federação.\r\nInformar 'EX' para operações com o exterior.","x-nullable":true},"infMunCarrega":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfMunCarrega"},"maxItems":50,"minItems":1},"infPercurso":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfPercurso"},"maxItems":25},"dhIniViagem":{"type":"string","format":"date-time","description":"Data e hora previstos de inicio da viagem.\r\nFormato AAAA-MM-DDTHH:MM:DD TZD.","x-nullable":true},"indCanalVerde":{"type":"integer","description":"Indicador de participação do Canal Verde.","x-nullable":true},"indCarregaPosterior":{"type":"integer","description":"Indicador de MDF-e com inclusão da Carga posterior a emissão por evento de inclusão de DF-e.","x-nullable":true}},"required":["infMunCarrega","UFFim","UFIni","verProc","procEmi","tpEmis","dhEmi","modal","nMDF","serie","tpEmit","cUF"]},"MdfeSefazInfMunCarrega":{"type":"object","description":"Informações dos Municípios de Carregamento.","properties":{"cMunCarrega":{"type":"string","description":"Código do Município de Carregamento.","x-nullable":true},"xMunCarrega":{"type":"string","description":"Nome do Município de Carregamento.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["xMunCarrega","cMunCarrega"]},"MdfeSefazInfPercurso":{"type":"object","description":"Informações do Percurso do MDF-e.","properties":{"UFPer":{"type":"string","description":"Sigla das Unidades da Federação do percurso do veículo.\r\nNão é necessário repetir as UF de Início e Fim.","x-nullable":true}},"required":["UFPer"]},"MdfeSefazEmit":{"type":"object","description":"Identificação do Emitente do Manifesto.","properties":{"CNPJ":{"type":"string","description":"CNPJ do emitente.\r\nInformar zeros não significativos.\r\n\r\n***Obrigatório caso o emitente seja pessoa jurídica***.","x-nullable":true},"CPF":{"type":"string","description":"CPF do emitente.\r\nInformar zeros não significativos.\r\nUsar com série específica 920-969 para emitente pessoa física com inscrição estadual.\r\nPoderá ser usado também para emissão do Regime Especial da Nota Fiscal Fácil.\r\n\r\n***Obrigatorio caso o emitente seja pessoa física***.","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual do emitemte.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xNome":{"type":"string","description":"Razão social ou Nome do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"enderEmit":{"$ref":"#/definitions/MdfeSefazEndeEmi"}}},"MdfeSefazEndeEmi":{"type":"object","description":"Endereço do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","properties":{"xLgr":{"type":"string","description":"Logradouro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE), informar 9999999 para operações com o exterior.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xMun":{"type":"string","description":"Nome do município, , informar EXTERIOR para operações com o exterior.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"CEP":{"type":"string","description":"CEP.\r\nInformar zeros não significativos.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF, , informar EX para operações com o exterior.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"fone":{"type":"string","description":"Telefone.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"email":{"type":"string","description":"Endereço de E-mail.","maxLength":60,"minLength":6,"x-nullable":true}}},"MdfeSefazInfModal":{"type":"object","description":"Informações do modal.","properties":{"versaoModal":{"type":"string","description":"Versão do leiaute específico para o Modal.","x-nullable":true},"aereo":{"$ref":"#/definitions/MdfeSefazAereo"},"rodo":{"$ref":"#/definitions/MdfeSefazRodo"},"aquav":{"$ref":"#/definitions/MdfeSefazAquav"},"ferrov":{"$ref":"#/definitions/MdfeSefazFerrov"}},"required":["versaoModal"]},"MdfeSefazAereo":{"type":"object","description":"Informações do modal Aéreo.","properties":{"nac":{"type":"string","description":"Marca da Nacionalidade da aeronave.","maxLength":4,"minLength":1,"x-nullable":true},"matr":{"type":"string","description":"Marca de Matrícula da aeronave.","maxLength":6,"minLength":1,"x-nullable":true},"nVoo":{"type":"string","description":"Número do Voo.\r\nFormato = AB1234, sendo AB a designação da empresa e 1234 o número do voo. Quando não for possível incluir as marcas de nacionalidade e matrícula sem hífen.","maxLength":9,"minLength":5,"x-nullable":true},"cAerEmb":{"type":"string","description":"Aeródromo de Embarque.\r\nO código de três letras IATA do aeroporto de partida deverá ser incluído como primeira anotação. Quando não for possível, utilizar a sigla OACI.","maxLength":4,"minLength":3,"x-nullable":true},"cAerDes":{"type":"string","description":"Aeródromo de Destino.\r\nO código de três letras IATA do aeroporto de destino deverá ser incluído como primeira anotação. Quando não for possível, utilizar a sigla OACI.","maxLength":4,"minLength":3,"x-nullable":true},"dVoo":{"type":"string","format":"date","description":"Data do Voo.\r\nFormato AAAA-MM-DD.","x-nullable":true}},"required":["dVoo","cAerDes","cAerEmb","nVoo","matr","nac"]},"MdfeSefazRodo":{"type":"object","description":"Informações do modal Rodoviário.","properties":{"infANTT":{"$ref":"#/definitions/MdfeSefazInfANTT"},"veicTracao":{"$ref":"#/definitions/MdfeSefazVeicTracao"},"veicReboque":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazVeicReboque"},"maxItems":3},"codAgPorto":{"type":"string","description":"Código de Agendamento no porto.","maxLength":16,"minLength":0,"x-nullable":true},"lacRodo":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazLacRodo"}}},"required":["veicTracao"]},"MdfeSefazInfANTT":{"type":"object","description":"Grupo de informações para Agência Reguladora.","properties":{"RNTRC":{"type":"string","description":"Registro Nacional de Transportadores Rodoviários de Carga.\r\nRegistro obrigatório do emitente do MDF-e junto à ANTT para exercer a atividade de transportador rodoviário de cargas por conta de terceiros e mediante remuneração.","x-nullable":true},"infCIOT":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfCIOT"}},"valePed":{"$ref":"#/definitions/MdfeSefazValePed"},"infContratante":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfContratante"}},"infPag":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfPag"}}}},"MdfeSefazInfCIOT":{"type":"object","description":"Dados do CIOT.","properties":{"CIOT":{"type":"string","description":"Código Identificador da Operação de Transporte.\r\nTambém Conhecido como conta frete.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF responsável pela geração do CIOT.\r\nInformar os zeros não significativos.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ responsável pela geração do CIOT.\r\nInformar os zeros não significativos.","x-nullable":true}}},"MdfeSefazValePed":{"type":"object","description":"Informações de Vale Pedágio.\r\nOutras informações sobre Vale-Pedágio obrigatório que não tenham campos específicos devem ser informadas no campo de observações gerais de uso livre pelo contribuinte, visando atender as determinações legais vigentes.","properties":{"disp":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazDisp"},"minItems":1},"categCombVeic":{"type":"string","description":"Categoria de Combinação Veicular.\r\nPreencher com:\r\n02 Veículo Comercial 2 eixos\r\n0\r\n4 Veículo Comercial 3 eixos\r\n06 Veículo Comercial 4 eixos\r\n0\r\n7 Veículo Comercial 5 eixos\r\n0\r\n8 Veículo Comercial 6 eixos\r\n10 Veículo Comercial 7 eixos\r\n11 Veículo Comercial 8 eixos\r\n12 Veículo Comercial 9 eixos\r\n13 Veículo Comercial 10 eixos\r\n14 Veículo Comercial Acima de 10 eixos.","x-nullable":true}},"required":["disp"]},"MdfeSefazDisp":{"type":"object","description":"Informações dos dispositivos do Vale Pedágio.","properties":{"CNPJForn":{"type":"string","description":"CNPJ da empresa fornecedora do Vale-Pedágio.\r\n* CNPJ da Empresa Fornecedora do Vale-Pedágio, ou seja, empresa que fornece ao Responsável pelo Pagamento do Vale-Pedágio os dispositivos do Vale-Pedágio.\r\n* Informar os zeros não significativos.","x-nullable":true},"CNPJPg":{"type":"string","description":"CNPJ do responsável pelo pagamento do Vale-Pedágio.\r\n* responsável pelo pagamento do Vale Pedágio. Informar somente quando o responsável não for o emitente do MDF-e.\r\n* Informar os zeros não significativos.","x-nullable":true},"CPFPg":{"type":"string","description":"CNPJ do responsável pelo pagamento do Vale-Pedágio.\r\nInformar os zeros não significativos.","x-nullable":true},"nCompra":{"type":"string","description":"Identificador do vale pedagio obrigatório - IDVPO.","x-nullable":true},"vValePed":{"type":"number","description":"Valor do Vale-Pedagio.\r\nValor do Vale-Pedágio obrigatório necessário à livre circulação, desde a origem da operação de transporte até o destino, do transportador contratado.","minimum":0,"x-nullable":true},"tpValePed":{"type":"string","description":"Tipo do Vale Pedagio.\r\n* 01 - TAG; 04 - Leitura de placa (pela placa de identificação veicular)","x-nullable":true}},"required":["vValePed","CNPJForn"]},"MdfeSefazInfContratante":{"type":"object","description":"Grupo de informações dos contratantes do serviço de transporte.","properties":{"xNome":{"type":"string","description":"Razão social ou Nome do contratante.","maxLength":60,"minLength":2,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF do contratante do serviço.\r\nInformar os zeros não significativos.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ do contratante do serviço.\r\nInformar os zeros não significativos.","x-nullable":true},"idEstrangeiro":{"type":"string","description":"Identificador do contratante em caso de contratante estrangeiro.","maxLength":20,"minLength":2,"x-nullable":true},"infContrato":{"$ref":"#/definitions/MdfeSefazInfContrato"}}},"MdfeSefazInfContrato":{"type":"object","description":"Grupo de informações do contrato entre transportador e contratante.","properties":{"NroContrato":{"type":"string","description":"Número do contrato do transportador com o contratante quando este existir para prestações continuadas.","maxLength":20,"minLength":2,"x-nullable":true},"vContratoGlobal":{"type":"number","description":"Valor global do contrato.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}},"required":["vContratoGlobal","NroContrato"]},"MdfeSefazInfPag":{"type":"object","description":"Informações do Pagamento do Contrato.","properties":{"xNome":{"type":"string","description":"Razão social ou Nome do respnsável pelo pagamento.","maxLength":60,"minLength":2,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF do responsável pelo pgto.\r\nInformar os zeros não significativos.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ do responsável pelo pgto.\r\nInformar os zeros não significativos.","x-nullable":true},"idEstrangeiro":{"type":"string","description":"Identificador do responsável pelo pgto em caso de ser estrangeiro.","maxLength":20,"minLength":2,"x-nullable":true},"Comp":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazComp"},"minItems":1},"vContrato":{"type":"number","description":"Valor Total do Contrato.","minimum":0,"x-nullable":true},"indAltoDesemp":{"type":"integer","description":"Indicador de operação de transporte de alto desempenho.\r\nOperação de transporte com utilização de veículos de frotas dedicadas ou fidelizadas.\r\nPreencher com “1” para indicar operação de transporte de alto desempenho, demais casos não informar a tag.","x-nullable":true},"indPag":{"type":"integer","description":"Indicador da Forma de Pagamento:0-Pagamento à Vista\r\n* 1 - Pagamento à Prazo","x-nullable":true},"vAdiant":{"type":"number","description":"Valor do Adiantamento (usar apenas em pagamento à Prazo.","minimum":0,"x-nullable":true},"indAntecipaAdiant":{"type":"integer","description":"Indicador para declarar concordância em antecipar o adiantamento.\r\nInformar a tag somente se for autorizado antecipar o adiantamento.","x-nullable":true},"infPrazo":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfPrazo"}},"tpAntecip":{"type":"integer","description":"Tipo de Permissão em relação a antecipação das parcelas.\r\n* 0 - Não permite antecipar\r\n* 1 - Permite antecipar as parcelas\r\n* 2 - Permite antecipar as parcelas mediante confirmação","x-nullable":true},"infBanc":{"$ref":"#/definitions/MdfeSefazInfBanc"}},"required":["infBanc","indPag","vContrato","Comp"]},"MdfeSefazComp":{"type":"object","description":"Componentes do Pagamentoi do Contrato.","properties":{"tpComp":{"type":"string","description":"Tipo do Componente.\r\nPreencher com:\r\n* 01 - Vale Pedágio\r\n* 02 - Impostos, taxas e contribuições\r\n* 03 - Despesas (bancárias, meios de pagamento, outras)\r\n* 04 - Frete\r\n* 99 - Outros","x-nullable":true},"vComp":{"type":"number","description":"Valor do componente.","minimum":0,"x-nullable":true},"xComp":{"type":"string","description":"Descrição do componente do tipo Outros.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["vComp","tpComp"]},"MdfeSefazInfPrazo":{"type":"object","description":"Informações do pagamento a prazo.\r\nInformar somente se indPag for à Prazo.","properties":{"nParcela":{"type":"integer","description":"Número da Parcela.","maximum":999,"minimum":0,"x-nullable":true},"dVenc":{"type":"string","format":"date","description":"Data de vencimento da Parcela (AAAA-MM-DD).","x-nullable":true},"vParcela":{"type":"number","description":"Valor da Parcela.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}},"required":["vParcela","dVenc","nParcela"]},"MdfeSefazInfBanc":{"type":"object","description":"Informações bancárias.","properties":{"codBanco":{"type":"string","description":"Número do banco.","maxLength":5,"minLength":3,"x-nullable":true},"codAgencia":{"type":"string","description":"Número da agência bancária.","maxLength":10,"minLength":1,"x-nullable":true},"CNPJIPEF":{"type":"string","description":"Número do CNPJ da Instituição de Pagamento Eletrônico do Frete.\r\nInformar os zeros não significativos.","x-nullable":true},"PIX":{"type":"string","description":"Chave PIX.\r\nInformar a chave PIX para recebimento do frete.\r\nPode ser email, CPF/ CNPJ (somente numeros), Telefone com a seguinte formatação (+5599999999999) ou a chave aleatória gerada pela instituição.","maxLength":60,"minLength":2,"x-nullable":true}}},"MdfeSefazVeicTracao":{"type":"object","description":"Dados do Veículo com a Tração.","properties":{"cInt":{"type":"string","description":"Código interno do veículo.","maxLength":10,"minLength":1,"x-nullable":true},"placa":{"type":"string","description":"Placa do veículo.","x-nullable":true},"RENAVAM":{"type":"string","description":"RENAVAM do veículo.","maxLength":11,"minLength":9,"x-nullable":true},"tara":{"type":"integer","description":"Tara em KG.","maximum":999999,"minimum":0,"x-nullable":true},"capKG":{"type":"integer","description":"Capacidade em KG.","maximum":999999,"minimum":0,"x-nullable":true},"capM3":{"type":"integer","description":"Capacidade em M3.","maximum":999,"minimum":0,"x-nullable":true},"prop":{"$ref":"#/definitions/MdfeSefazProp"},"condutor":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazCondutor"},"maxItems":10,"minItems":1},"tpRod":{"type":"string","description":"Tipo de Rodado.\r\nPreencher com:\r\n* 01 - Truck\r\n* 02 - Toco\r\n* 03 - Cavalo Mecânico\r\n* 04 - VAN\r\n* 05 - Utilitário\r\n* 06 - Outros","x-nullable":true},"tpCar":{"type":"string","description":"Tipo de Carroceria.\r\nPreencher com:\r\n* 00 - não aplicável\r\n* 01 - Aberta\r\n* 02 - Fechada/Baú\r\n* 03 - Granelera\r\n* 04 - Porta Container\r\n* 05 - Sider","x-nullable":true},"UF":{"type":"string","description":"UF em que veículo está licenciado.\r\nSigla da UF de licenciamento do veículo.","x-nullable":true}},"required":["tpCar","tpRod","condutor","tara","placa"]},"MdfeSefazProp":{"type":"object","description":"Proprietário ou possuidor do Veículo.\r\nSó preenchido quando o veículo não pertencer à empresa emitente do MDF-e.","properties":{"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar os zeros não significativos.","x-nullable":true},"RNTRC":{"type":"string","description":"Registro Nacional dos Transportadores Rodoviários de Carga.\r\nRegistro obrigatório do proprietário, co-proprietário ou arrendatário do veículo junto à ANTT para exercer a atividade de transportador rodoviário de cargas por conta de terceiros e mediante remuneração.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do proprietário.","maxLength":60,"minLength":2,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","x-nullable":true},"UF":{"type":"string","description":"UF.","x-nullable":true},"tpProp":{"type":"integer","description":"Tipo Proprietário ou possuidor.\r\nPreencher com:\r\n* 0 - TAC Agregado\r\n* 1 - TAC Independente\r\n* 2 - Outros","x-nullable":true}},"required":["tpProp","xNome","RNTRC"]},"MdfeSefazCondutor":{"type":"object","description":"Informações do(s) Condutor(es) do veículo.","properties":{"xNome":{"type":"string","description":"Nome do Condutor.","maxLength":60,"minLength":2,"x-nullable":true},"CPF":{"type":"string","description":"CPF do Condutor.","x-nullable":true}},"required":["CPF","xNome"]},"MdfeSefazVeicReboque":{"type":"object","description":"Dados dos reboques.","properties":{"cInt":{"type":"string","description":"Código interno do veículo.","maxLength":10,"minLength":1,"x-nullable":true},"placa":{"type":"string","description":"Placa do veículo.","x-nullable":true},"RENAVAM":{"type":"string","description":"RENAVAM do veículo.","maxLength":11,"minLength":9,"x-nullable":true},"tara":{"type":"integer","description":"Tara em KG.","maximum":999999,"minimum":0,"x-nullable":true},"capKG":{"type":"integer","description":"Capacidade em KG.","maximum":999999,"minimum":0,"x-nullable":true},"capM3":{"type":"integer","description":"Capacidade em M3.","maximum":999,"minimum":0,"x-nullable":true},"prop":{"$ref":"#/definitions/MdfeSefazVeicReboque_Prop"},"tpCar":{"type":"string","description":"Tipo de Carroceria.\r\nPreencher com:\r\n* 00 - não aplicável\r\n* 01 - Aberta\r\n* 02 - Fechada/Baú\r\n* 03 - Granelera\r\n* 04 - Porta Container\r\n* 05 - Sider","x-nullable":true},"UF":{"type":"string","description":"UF em que veículo está licenciado.\r\nSigla da UF de licenciamento do veículo.","x-nullable":true}},"required":["tpCar","capKG","tara","placa"]},"MdfeSefazVeicReboque_Prop":{"type":"object","description":"Proprietários ou possuidor do Veículo.\r\nSó preenchido quando o veículo não pertencer à empresa emitente do MDF-e.","properties":{"CPF":{"type":"string","description":"Número do CPF.\r\nInformar os zeros não significativos.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ.\r\nInformar os zeros não significativos.","x-nullable":true},"RNTRC":{"type":"string","description":"Registro Nacional dos Transportadores Rodoviários de Carga.\r\nRegistro obrigatório do proprietário, co-proprietário ou arrendatário do veículo junto à ANTT para exercer a atividade de transportador rodoviário de cargas por conta de terceiros e mediante remuneração.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do proprietário.","maxLength":60,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual.","x-nullable":true},"UF":{"type":"string","description":"UF.","x-nullable":true},"tpProp":{"type":"integer","description":"Tipo Proprietário ou possuidor.\r\nPreencher com:\r\n* 0 - TAC Agregado\r\n* 1 - TAC Independente\r\n* 2 - Outros","x-nullable":true}},"required":["tpProp","xNome","RNTRC"]},"MdfeSefazLacRodo":{"type":"object","description":"Lacres.","properties":{"nLacre":{"type":"string","description":"Número do Lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"MdfeSefazAquav":{"type":"object","description":"Informações do modal Aquaviário.","properties":{"irin":{"type":"string","description":"Irin do navio sempre deverá ser informado.","maxLength":10,"minLength":1,"x-nullable":true},"tpEmb":{"type":"string","description":"Código do tipo de embarcação.\r\nPreencher com código da Tabela de Tipo de Embarcação definida no Ministério dos Transportes.","x-nullable":true},"cEmbar":{"type":"string","description":"Código da embarcação.","maxLength":10,"minLength":1,"x-nullable":true},"xEmbar":{"type":"string","description":"Nome da embarcação.","maxLength":60,"minLength":1,"x-nullable":true},"nViag":{"type":"string","description":"Número da Viagem.","x-nullable":true},"cPrtEmb":{"type":"string","description":"Código do Porto de Embarque.\r\nPreencher de acordo com Tabela de Portos definida no Ministério dos Transportes.","maxLength":5,"minLength":1,"x-nullable":true},"cPrtDest":{"type":"string","description":"Código do Porto de Destino.\r\nPreencher de acordo com Tabela de Portos definida no Ministério dos Transportes.","maxLength":5,"minLength":1,"x-nullable":true},"prtTrans":{"type":"string","description":"Porto de Transbordo.","maxLength":60,"minLength":1,"x-nullable":true},"tpNav":{"type":"integer","description":"Tipo de Navegação.\r\nPreencher com:\r\n* 0 - Interior\r\n* 1 - Cabotagem","x-nullable":true},"infTermCarreg":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfTermCarreg"},"maxItems":5},"infTermDescarreg":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfTermDescarreg"},"maxItems":5},"infEmbComb":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfEmbComb"},"maxItems":30},"infUnidCargaVazia":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfUnidCargaVazia"}},"infUnidTranspVazia":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfUnidTranspVazia"}},"MMSI":{"type":"string","description":"Maritime Mobile Service Identify.\r\nPreencher com o MMSI (Maritime Mobile Service Identify) fornecido pela ANATEL ou autoridade de telecomunicações de origem da embarcação.","maxLength":9,"minLength":1,"x-nullable":true}},"required":["cPrtDest","cPrtEmb","nViag","xEmbar","cEmbar","tpEmb","irin"]},"MdfeSefazInfTermCarreg":{"type":"object","description":"Grupo de informações dos terminais de carregamento.","properties":{"cTermCarreg":{"type":"string","description":"Código do Terminal de Carregamento.\r\nPreencher de acordo com a Tabela de Terminais de Carregamento. O código de cada Porto está definido no Ministério de Transportes.","maxLength":8,"minLength":1,"x-nullable":true},"xTermCarreg":{"type":"string","description":"Nome do Terminal de Carregamento.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTermCarreg","cTermCarreg"]},"MdfeSefazInfTermDescarreg":{"type":"object","description":"Grupo de informações dos terminais de descarregamento.","properties":{"cTermDescarreg":{"type":"string","description":"Código do Terminal de Descarregamento.\r\nPreencher de acordo com a Tabela de Terminais de Descarregamento. O código de cada Porto está definido no Ministério de Transportes.","maxLength":8,"minLength":1,"x-nullable":true},"xTermDescarreg":{"type":"string","description":"Nome do Terminal de Descarregamento.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xTermDescarreg","cTermDescarreg"]},"MdfeSefazInfEmbComb":{"type":"object","description":"Informações das Embarcações do Comboio.","properties":{"cEmbComb":{"type":"string","description":"Código da embarcação do comboio.","maxLength":10,"minLength":1,"x-nullable":true},"xBalsa":{"type":"string","description":"Identificador da Balsa.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xBalsa","cEmbComb"]},"MdfeSefazInfUnidCargaVazia":{"type":"object","description":"Informações das Undades de Carga vazias.","properties":{"idUnidCargaVazia":{"type":"string","description":"Identificação da unidades de carga vazia.","maxLength":20,"minLength":1,"x-nullable":true},"tpUnidCargaVazia":{"type":"integer","description":"Tipo da unidade de carga vazia.\r\n* 1 - Container\r\n* 2 - ULD\r\n* 3 - Pallet\r\n* 4 - Outros","x-nullable":true}},"required":["tpUnidCargaVazia","idUnidCargaVazia"]},"MdfeSefazInfUnidTranspVazia":{"type":"object","description":"Informações das Undades de Transporte vazias.","properties":{"idUnidTranspVazia":{"type":"string","description":"Identificação da unidades de transporte vazia.","maxLength":20,"minLength":1,"x-nullable":true},"tpUnidTranspVazia":{"type":"integer","description":"Tipo da unidade de transporte vazia.\r\nDeve ser preenchido com “1” para Rodoviário Tração do tipo caminhão ou “2” para Rodoviário reboque do tipo carreta.","x-nullable":true}},"required":["tpUnidTranspVazia","idUnidTranspVazia"]},"MdfeSefazFerrov":{"type":"object","description":"Informações do modal Ferroviário.","properties":{"trem":{"$ref":"#/definitions/MdfeSefazTrem"},"vag":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazVag"},"minItems":1}},"required":["vag","trem"]},"MdfeSefazTrem":{"type":"object","description":"Informações da composição do trem.","properties":{"xPref":{"type":"string","description":"Prefixo do Trem.","maxLength":10,"minLength":1,"x-nullable":true},"dhTrem":{"type":"string","format":"date-time","description":"Data e hora de liberação do trem na origem.","x-nullable":true},"xOri":{"type":"string","description":"Origem do Trem.\r\nSigla da estação de origem.","maxLength":3,"minLength":1,"x-nullable":true},"xDest":{"type":"string","description":"Destino do Trem.\r\nSigla da estação de destino.","maxLength":3,"minLength":1,"x-nullable":true},"qVag":{"type":"integer","description":"Quantidade de vagões carregados.","maximum":999,"minimum":1,"x-nullable":true}},"required":["qVag","xDest","xOri","xPref"]},"MdfeSefazVag":{"type":"object","description":"informações dos Vagões.","properties":{"pesoBC":{"type":"number","description":"Peso Base de Cálculo de Frete em Toneladas.","minimum":0,"x-nullable":true},"pesoR":{"type":"number","description":"Peso Real em Toneladas.","minimum":0,"x-nullable":true},"tpVag":{"type":"string","description":"Tipo de Vagão.","maxLength":3,"x-nullable":true},"serie":{"type":"string","description":"Serie de Identificação do vagão.","maxLength":3,"x-nullable":true},"nVag":{"type":"integer","description":"Número de Identificação do vagão.","maximum":99999999,"minimum":1,"x-nullable":true},"nSeq":{"type":"integer","description":"Sequencia do vagão na composição.","maximum":999,"minimum":1,"x-nullable":true},"TU":{"type":"number","description":"Tonelada Útil.\r\nUnidade de peso referente à carga útil (apenas o peso da carga transportada), expressa em toneladas.","x-nullable":true}},"required":["TU","nVag","serie","pesoR","pesoBC"]},"MdfeSefazInfDoc":{"type":"object","description":"Informações dos Documentos fiscais vinculados ao manifesto.","properties":{"infMunDescarga":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfMunDescarga"},"maxItems":1000,"minItems":1}},"required":["infMunDescarga"]},"MdfeSefazInfMunDescarga":{"type":"object","description":"Informações dos Municípios de descarregamento.","properties":{"cMunDescarga":{"type":"string","description":"Código do Município de Descarregamento.","x-nullable":true},"xMunDescarga":{"type":"string","description":"Nome do Município de Descarregamento.","maxLength":60,"minLength":2,"x-nullable":true},"infCTe":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfCTe"},"maxItems":20000},"infNFe":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfNFe"},"maxItems":20000},"infMDFeTransp":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfMDFeTransp"},"maxItems":20000}},"required":["xMunDescarga","cMunDescarga"]},"MdfeSefazInfCTe":{"type":"object","description":"Conhecimentos de Tranporte - usar este grupo quando for prestador de serviço de transporte.","properties":{"chCTe":{"type":"string","description":"Conhecimento Eletrônico - Chave de Acesso.","maxLength":44,"x-nullable":true},"SegCodBarra":{"type":"string","description":"Segundo código de barras.","x-nullable":true},"indReentrega":{"type":"integer","description":"Indicador de Reentrega.","x-nullable":true},"infUnidTransp":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazUnidadeTransp"}},"peri":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazPeri"}},"infEntregaParcial":{"$ref":"#/definitions/MdfeSefazInfEntregaParcial"},"indPrestacaoParcial":{"type":"integer","description":"Indicador de Prestação parcial.","x-nullable":true},"infNFePrestParcial":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfNFePrestParcial"}}},"required":["chCTe"]},"MdfeSefazUnidadeTransp":{"type":"object","description":"Informações das Unidades de Transporte (Carreta/Reboque/Vagão).\r\nDeve ser preenchido com as informações das unidades de transporte utilizadas.","properties":{"tpUnidTransp":{"type":"integer","description":"Tipo da Unidade de Transporte.\r\n* 1 - Rodoviário Tração\r\n* 2 - Rodoviário Reboque\r\n* 3 - Navio\r\n* 4 - Balsa\r\n* 5 - Aeronave\r\n* 6 - Vagão\r\n* 7 - Outros","x-nullable":true},"idUnidTransp":{"type":"string","description":"Identificação da Unidade de Transporte.\r\nInformar a identificação conforme o tipo de unidade de transporte.\r\nPor exemplo: para rodoviário tração ou reboque deverá preencher com a placa do veículo.","maxLength":20,"minLength":1,"x-nullable":true},"lacUnidTransp":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazLacUnidTransp"}},"infUnidCarga":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazUnidCarga"}},"qtdRat":{"type":"number","description":"Quantidade rateada (Peso,Volume).","minimum":0,"x-nullable":true}},"required":["idUnidTransp","tpUnidTransp"]},"MdfeSefazLacUnidTransp":{"type":"object","description":"Lacres das Unidades de Transporte.","properties":{"nLacre":{"type":"string","description":"Número do lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"MdfeSefazUnidCarga":{"type":"object","description":"Informações das Unidades de Carga (Containeres/ULD/Outros).\r\nDispositivo de carga utilizada (Unit Load Device - ULD) significa todo tipo de contêiner de carga, vagão, contêiner de avião, palete de aeronave com rede ou palete de aeronave com rede sobre um iglu.","properties":{"tpUnidCarga":{"type":"integer","description":"Tipo da Unidade de Carga.\r\n* 1 - Container\r\n* 2 - ULD\r\n* 3 - Pallet\r\n* 4 - Outros","x-nullable":true},"idUnidCarga":{"type":"string","description":"Identificação da Unidade de Carga.\r\nInformar a identificação da unidade de carga, por exemplo: número do container.","maxLength":20,"minLength":1,"x-nullable":true},"lacUnidCarga":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazLacUnidCarga"}},"qtdRat":{"type":"number","description":"Quantidade rateada (Peso,Volume).","x-nullable":true}},"required":["idUnidCarga","tpUnidCarga"]},"MdfeSefazLacUnidCarga":{"type":"object","description":"Lacres das Unidades de Carga.","properties":{"nLacre":{"type":"string","description":"Número do lacre.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"MdfeSefazPeri":{"type":"object","description":"Preenchido quando for  transporte de produtos classificados pela ONU como perigosos.","properties":{"nONU":{"type":"string","description":"Número ONU/UN.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","x-nullable":true},"xNomeAE":{"type":"string","description":"Nome apropriado para embarque do produto.\r\nVer a legislação de transporte de produtos perigosos aplicada ao modo de transporte.","maxLength":150,"minLength":1,"x-nullable":true},"xClaRisco":{"type":"string","description":"Classe ou subclasse/divisão, e risco subsidiário/risco secundário.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","maxLength":40,"minLength":1,"x-nullable":true},"grEmb":{"type":"string","description":"Grupo de Embalagem.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal\r\nPreenchimento obrigatório para o modal aéreo.\r\nA legislação para o modal rodoviário e ferroviário não atribui grupo de embalagem para todos os produtos, portanto haverá casos de não preenchimento desse campo.","maxLength":6,"minLength":1,"x-nullable":true},"qTotProd":{"type":"string","description":"Quantidade total por produto.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","maxLength":20,"minLength":1,"x-nullable":true},"qVolTipo":{"type":"string","description":"Quantidade e Tipo de volumes.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["qTotProd","nONU"]},"MdfeSefazInfEntregaParcial":{"type":"object","description":"Grupo de informações da Entrega Parcial (Corte de Voo).","properties":{"qtdTotal":{"type":"number","description":"Quantidade total de volumes.","minimum":0,"x-nullable":true},"qtdParcial":{"type":"number","description":"Quantidade de volumes enviados no MDF-e.","minimum":0,"x-nullable":true}},"required":["qtdParcial","qtdTotal"]},"MdfeSefazInfNFePrestParcial":{"type":"object","description":"Grupo de informações das NFe que foram entregues do CTe relacionado.","properties":{"chNFe":{"type":"string","description":"Nota Fiscal Eletrônica.","maxLength":44,"x-nullable":true}},"required":["chNFe"]},"MdfeSefazInfNFe":{"type":"object","description":"Nota Fiscal Eletronica.","properties":{"chNFe":{"type":"string","description":"Nota Fiscal Eletrônica.","maxLength":44,"x-nullable":true},"SegCodBarra":{"type":"string","description":"Segundo código de barras.","x-nullable":true},"indReentrega":{"type":"integer","description":"Indicador de Reentrega.","x-nullable":true},"infUnidTransp":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazUnidadeTransp"}},"peri":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfNFe_Peri"}}},"required":["chNFe"]},"MdfeSefazInfNFe_Peri":{"type":"object","description":"Preenchido quando for  transporte de produtos classificados pela ONU como perigosos.","properties":{"nONU":{"type":"string","description":"Número ONU/UN.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","x-nullable":true},"xNomeAE":{"type":"string","description":"Nome apropriado para embarque do produto.\r\nVer a legislação de transporte de produtos perigosos aplicada ao modo de transporte.","maxLength":150,"minLength":1,"x-nullable":true},"xClaRisco":{"type":"string","description":"Classe ou subclasse/divisão, e risco subsidiário/risco secundário.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","maxLength":40,"minLength":1,"x-nullable":true},"grEmb":{"type":"string","description":"Grupo de Embalagem.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal\r\nPreenchimento obrigatório para o modal aéreo.\r\nA legislação para o modal rodoviário e ferroviário não atribui grupo de embalagem para todos os produtos, portanto haverá casos de não preenchimento desse campo.","maxLength":6,"minLength":1,"x-nullable":true},"qTotProd":{"type":"string","description":"Quantidade total por produto.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","maxLength":20,"minLength":1,"x-nullable":true},"qVolTipo":{"type":"string","description":"Quantidade e Tipo de volumes.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["qTotProd","nONU"]},"MdfeSefazInfMDFeTransp":{"type":"object","description":"Manifesto Eletrônico de Documentos Fiscais. Somente para modal Aquaviário (vide regras MOC).","properties":{"chMDFe":{"type":"string","description":"Manifesto Eletrônico de Documentos Fiscais.","maxLength":44,"x-nullable":true},"indReentrega":{"type":"integer","description":"Indicador de Reentrega.","x-nullable":true},"infUnidTransp":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazUnidadeTransp"}},"peri":{"type":"array","items":{"$ref":"#/definitions/MdfeSefazInfMDFeTransp_Peri"}}},"required":["chMDFe"]},"MdfeSefazInfMDFeTransp_Peri":{"type":"object","description":"Preenchido quando for  transporte de produtos classificados pela ONU como perigosos.","properties":{"nONU":{"type":"string","description":"Número ONU/UN.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","x-nullable":true},"xNomeAE":{"type":"string","description":"Nome apropriado para embarque do produto.\r\nVer a legislação de transporte de produtos perigosos aplicada ao modo de transporte.","maxLength":150,"minLength":1,"x-nullable":true},"xClaRisco":{"type":"string","description":"Classe ou subclasse/divisão, e risco subsidiário/risco secundário.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal.","maxLength":40,"minLength":1,"x-nullable":true},"grEmb":{"type":"string","description":"Grupo de Embalagem.\r\nVer a legislação de transporte de produtos perigosos aplicadas ao modal\r\nPreenchimento obrigatório para o modal aéreo.\r\nA legislação para o modal rodoviário e ferroviário não atribui grupo de embalagem para todos os produtos, portanto haverá casos de não preenchimento desse campo.","maxLength":6,"minLength":1,"x-nullable":true},"qTotProd":{"type":"string","description":"Quantidade total por produto.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","maxLength":20,"minLength":1,"x-nullable":true},"qVolTipo":{"type":"string","description":"Quantidade e Tipo de volumes.\r\nPreencher conforme a legislação de transporte de produtos perigosos aplicada ao modal.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["qTotProd","nONU"]},"MdfeSefazSeg":{"type":"object","description":"Informações de Seguro da Carga.","properties":{"infResp":{"$ref":"#/definitions/MdfeSefazInfResp"},"infSeg":{"$ref":"#/definitions/MdfeSefazInfSeg"},"nApol":{"type":"string","description":"Número da Apólice.\r\nObrigatório pela lei 11.442/07 (RCTRC).","maxLength":20,"minLength":1,"x-nullable":true},"nAver":{"type":"array","description":"Número da Averbação.\r\nInformar as averbações do seguro.","items":{"type":"string"}}},"required":["infResp"]},"MdfeSefazInfResp":{"type":"object","description":"Informações do responsável pelo seguro da carga.","properties":{"respSeg":{"type":"integer","description":"Responsável pelo seguro.\r\nPreencher com:\r\n* 1 - Emitente do MDF-e\r\n* 22 - Responsável pela contratação do serviço de transporte (contratante)\r\nDados obrigatórios apenas no modal Rodoviário, depois da lei 11.442/07. Para os demais modais esta informação é opcional.","x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ do responsável pelo seguro.\r\nObrigatório apenas se responsável pelo seguro for (2) responsável pela contratação do transporte - pessoa jurídica.","x-nullable":true},"CPF":{"type":"string","description":"Número do CPF do responsável pelo seguro.\r\nObrigatório apenas se responsável pelo seguro for (2) responsável pela contratação do transporte - pessoa física.","x-nullable":true}},"required":["respSeg"]},"MdfeSefazInfSeg":{"type":"object","description":"Informações da seguradora.","properties":{"xSeg":{"type":"string","description":"Nome da Seguradora.","maxLength":30,"minLength":1,"x-nullable":true},"CNPJ":{"type":"string","description":"Número do CNPJ da seguradora.\r\nObrigatório apenas se responsável pelo seguro for (2) responsável pela contratação do transporte - pessoa jurídica.","x-nullable":true}},"required":["CNPJ","xSeg"]},"MdfeSefazProdPred":{"type":"object","description":"Produto predominante.\r\nInformar a descrição do produto predominante, conforme o item de maior valor financeiro conforme Resolução ANTT n° 5.867 de 2020).","properties":{"tpCarga":{"type":"string","description":"Tipo de Carga.\r\nConforme Resolução ANTT nº.  5.849/2019.\r\n* 01 - Granel sólido\r\n* 02 - Granel líquido\r\n* 03 - Frigorificada\r\n* 04 - Conteinerizada\r\n* 05 - Carga Geral\r\n* 06 - Neogranel\r\n* 07 - Perigosa (granel sólido)\r\n* 08 - Perigosa (granel líquido)\r\n* 09 - Perigosa (carga frigorificada)\r\n* 10 - Perigosa (conteinerizada)\r\n* 11 - Perigosa (carga geral)\r\n* 12 - Granel pressurizada","x-nullable":true},"xProd":{"type":"string","description":"Descrição do produto.","maxLength":120,"minLength":1,"x-nullable":true},"cEAN":{"type":"string","description":"GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras.","x-nullable":true},"NCM":{"type":"string","description":"Código NCM.","x-nullable":true},"infLotacao":{"$ref":"#/definitions/MdfeSefazInfLotacao"}},"required":["xProd","tpCarga"]},"MdfeSefazInfLotacao":{"type":"object","description":"Informações da carga lotação. Informar somente quando MDF-e for de carga lotação.","properties":{"infLocalCarrega":{"$ref":"#/definitions/MdfeSefazInfLocalCarrega"},"infLocalDescarrega":{"$ref":"#/definitions/MdfeSefazInfLocalDescarrega"}},"required":["infLocalDescarrega","infLocalCarrega"]},"MdfeSefazInfLocalCarrega":{"type":"object","description":"Informações da localização de carregamento do MDF-e de carga lotação.","properties":{"CEP":{"type":"string","description":"CEP onde foi carregado o MDF-e.\r\nInformar zeros não significativos.","x-nullable":true},"latitude":{"type":"string","description":"Latitude do ponto geográfico onde foi carregado o MDF-e.","x-nullable":true},"longitude":{"type":"string","description":"Latitude do ponto geográfico onde foi carregado o MDF-e.","x-nullable":true}}},"MdfeSefazInfLocalDescarrega":{"type":"object","description":"Informações da localização de descarregamento do MDF-e de carga lotação.","properties":{"CEP":{"type":"string","description":"CEP onde foi descarregado o MDF-e.\r\nInformar zeros não significativos.","x-nullable":true},"latitude":{"type":"string","description":"Latitude do ponto geográfico onde foi descarregado o MDF-e.","x-nullable":true},"longitude":{"type":"string","description":"Latitude do ponto geográfico onde foi descarregado o MDF-e.","x-nullable":true}}},"MdfeSefazTot":{"type":"object","description":"Totalizadores da carga transportada e seus documentos fiscais.","properties":{"qCTe":{"type":"integer","description":"Quantidade total de CT-e relacionados no Manifesto.","maximum":999999,"minimum":0,"x-nullable":true},"qNFe":{"type":"integer","description":"Quantidade total de NF-e relacionadas no Manifesto.","maximum":999999,"minimum":0,"x-nullable":true},"qMDFe":{"type":"integer","description":"Quantidade total de MDF-e relacionados no Manifesto Aquaviário.","maximum":999999,"minimum":0,"x-nullable":true},"vCarga":{"type":"number","description":"Valor total da carga / mercadorias transportadas.","minimum":0,"x-nullable":true},"cUnid":{"type":"string","description":"Código da unidade de medida do Peso Bruto da Carga / Mercadorias transportadas.\r\n* 01 - KG\r\n* 02 - TON","x-nullable":true},"qCarga":{"type":"number","description":"Peso Bruto Total da Carga / Mercadorias transportadas.","minimum":0,"x-nullable":true}},"required":["qCarga","cUnid","vCarga"]},"MdfeSefazLacres":{"type":"object","description":"Lacres do MDF-e.\r\nPreechimento opcional para os modais Rodoviário e Ferroviário.","properties":{"nLacre":{"type":"string","description":"número do lacre.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"MdfeSefazAutXML":{"type":"object","description":"Autorizados para download do XML do DF-e.\r\nInformar CNPJ ou CPF. Preencher os zeros não significativos.","properties":{"CNPJ":{"type":"string","description":"CNPJ do autorizado.\r\nInformar zeros não significativos.","x-nullable":true},"CPF":{"type":"string","description":"CPF do autorizado.\r\nInformar zeros não significativos.","x-nullable":true}}},"MdfeSefazInfAdic":{"type":"object","description":"Informações Adicionais.","properties":{"infAdFisco":{"type":"string","description":"Informações adicionais de interesse do Fisco.\r\nNorma referenciada, informações complementares, etc.","maxLength":2000,"minLength":1,"x-nullable":true},"infCpl":{"type":"string","description":"Informações complementares de interesse do Contribuinte.","maxLength":5000,"minLength":1,"x-nullable":true}}},"MdfeSefazRespTec":{"type":"object","description":"Informações do Responsável Técnico pela emissão do DF-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ da pessoa jurídica responsável técnica pelo sistema utilizado na emissão do documento fiscal eletrônico.\r\nInformar o CNPJ da pessoa jurídica desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico.","x-nullable":true},"xContato":{"type":"string","description":"Nome da pessoa a ser contatada.\r\nInformar o nome da pessoa a ser contatada na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico. No caso de pessoa física, informar o respectivo nome.","maxLength":60,"minLength":2,"x-nullable":true},"email":{"type":"string","description":"Email da pessoa jurídica a ser contatada.","maxLength":60,"minLength":6,"x-nullable":true},"fone":{"type":"string","description":"Telefone da pessoa jurídica a ser contatada.\r\nPreencher com o Código DDD + número do telefone.","x-nullable":true},"idCSRT":{"type":"integer","description":"Identificador do código de segurança do responsável técnico.\r\nIdentificador do CSRT utilizado para geração do hash.","maximum":999,"minimum":0,"x-nullable":true},"CSRT":{"type":"string","description":"Código de Segurança do Responsável Técnico utilizado para montar o hash do CSRT.","x-nullable":true},"hashCSRT":{"type":"string","description":"Hash do token do código de segurança do responsável técnico.\r\nO hashCSRT é o resultado das funções SHA-1 e base64 do token CSRT fornecido pelo fisco + chave de acesso do DF-e. (Implementação em futura NT)\r\nObservação: 28 caracteres são representados no schema como 20 bytes do tipo base64Binary.\r\n\r\n*Se não informado, será calculado automaticamente, desde que os campos `idCSRT` e `CSRT` sejam fornecidos.*","maxLength":28,"x-nullable":true}},"required":["fone","email","xContato","CNPJ"]},"MdfeSefazInfSolicNFF":{"type":"object","description":"Grupo de informações do pedido de emissão da Nota Fiscal Fácil.","properties":{"xSolic":{"type":"string","description":"Solicitação do pedido de emissão da NFF.\r\nSerá preenchido com a totalidade de campos informados no aplicativo emissor serializado.","maxLength":8000,"minLength":2,"x-nullable":true}},"required":["xSolic"]},"MdfeSefazInfMDFeSupl":{"type":"object","description":"Informações suplementares do MDF-e.","properties":{"qrCodMDFe":{"type":"string","description":"Texto com o QR-Code para consulta do MDF-e.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":1000,"minLength":50,"x-nullable":true}}},"DfeLote":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para este documento."},"created_at":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["pendente","processado","erro"]},"ambiente":{"type":"string","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","x-nullable":true},"id_lote":{"type":"string","x-nullable":true},"recibo":{"$ref":"#/definitions/DfeRecibo"},"documentos":{"type":"array","items":{"$ref":"#/definitions/Dfe"}}}},"DfeRecibo":{"type":"object","properties":{"numero":{"type":"string","description":"Número do Recibo"},"codigo_status":{"type":"integer","description":"Código do status da mensagem enviada."},"motivo_status":{"type":"string","description":"Descrição literal do status do serviço solicitado."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora de processamento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."}}},"DfeLoteListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/DfeLote"}}}},"MdfePedidoCancelamento":{"type":"object","properties":{"justificativa":{"type":"string","description":"Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco."}}},"MdfePedidoEncerramento":{"type":"object","properties":{"data_encerramento":{"type":"string","format":"date","description":"Data que o manifesto foi encerrado.\r\n\r\nOpcional. Caso não seja informada, será utilizada a data em que a solicitação foi feita à API.","x-nullable":true},"uf":{"type":"string","description":"UF de encerramento do manifesto."},"codigo_municipio":{"type":"string","description":"Código IBGE do Município de encerramento do manifesto."}},"required":["codigo_municipio","uf"]},"MdfeEncerramento":{"type":"object","properties":{"data_encerramento":{"type":"string","format":"date","description":"Data que o manifesto foi encerrado."},"uf":{"type":"string","description":"UF de encerramento do manifesto."},"codigo_municipio":{"type":"string","description":"Código do Município de encerramento do manifesto."},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"MdfePedidoInclusaoCondutor":{"type":"object","properties":{"nome_condutor":{"type":"string","description":"Nome do condutor.","maxLength":60,"minLength":2},"cpf_condutor":{"type":"string","description":"CPF do condutor."}},"required":["cpf_condutor","nome_condutor"]},"MdfeInclusaoCondutor":{"type":"object","properties":{"nome_condutor":{"type":"string","description":"Nome do condutor."},"cpf_condutor":{"type":"string","description":"CPF do condutor."},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"MdfePedidoInclusaoDfe":{"type":"object","properties":{"codigo_municipio_carrega":{"type":"string","description":"Código do Município de carregamento."},"municipio_carrega":{"type":"string","description":"Nome do Município de carregamento."},"documentos":{"type":"array","description":"Informações dos documentos fiscais vinculados ao manifesto.","items":{"$ref":"#/definitions/MdfeDocumentoVinculado"}},"protocolo_autorizacao":{"type":"string"}}},"MdfeDocumentoVinculado":{"type":"object","properties":{"codigo_municipio_descarga":{"type":"string","description":"Código do Município de descarregamento."},"municipio_descarga":{"type":"string","description":"Nome do Município de descarregamento."},"chave_acesso_nfe":{"type":"string","description":"Chave de acesso da NF-e."}}},"MdfeInclusaoDfe":{"type":"object","properties":{"codigo_municipio_carrega":{"type":"string","description":"Código do Município de carregamento."},"municipio_carrega":{"type":"string","description":"Nome do Município de carregamento."},"documentos":{"type":"array","description":"Informações dos documentos fiscais vinculados ao manifesto.","items":{"$ref":"#/definitions/MdfeDocumentoVinculado"}},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"DfeContribuinteInfCons":{"type":"object","description":"Dados do Resultado do Dados do Pedido de Consulta de cadastro de contribuintes.","properties":{"codigo_status":{"type":"integer","description":"Código do status da mensagem enviada.","maximum":999,"minimum":0,"x-nullable":true},"motivo_status":{"type":"string","description":"Descrição literal do status do serviço solicitado.","maxLength":255,"minLength":1,"x-nullable":true},"uf":{"type":"string","description":"sigla da UF consultada, utilizar SU para SUFRAMA.","x-nullable":true},"ie":{"type":"string","description":"Inscrição Estadual do contribuinte.","x-nullable":true},"cnpj":{"type":"string","description":"CNPJ do contribuinte.","x-nullable":true},"cpf":{"type":"string","description":"CPF do contribuinte.","x-nullable":true},"data_consulta":{"type":"string","format":"date-time","description":"Data da Consulta.","x-nullable":true},"uf_atendimento":{"type":"integer","description":"código da UF de atendimento.","x-nullable":true},"informacoes_cadastrais":{"type":"array","items":{"$ref":"#/definitions/DfeContribuinteInfCad"}}},"required":["uf_atendimento","data_consulta","uf","motivo_status","codigo_status"]},"DfeContribuinteInfCad":{"type":"object","description":"Informações cadastrais do contribuinte consultado.","properties":{"ie":{"type":"string","description":"Número da Inscrição Estadual do contribuinte.","x-nullable":true},"cnpj":{"type":"string","description":"Número do CNPJ  do contribuinte.","x-nullable":true},"cpf":{"type":"string","description":"Número do CPF do contribuinte.","x-nullable":true},"uf":{"type":"string","description":"Sigla da UF de localização do contribuinte. Em algumas situações, a UF de localização pode ser diferente da UF consultada. Ex. IE de Substituto Tributário.","x-nullable":true},"situacao_cadastral":{"type":"integer","description":"Situação cadastral do contribuinte:\r\n* 0 - não habilitado\r\n* 1 - habilitado","x-nullable":true},"indicador_nfe":{"type":"integer","description":"Indicador de contribuinte credenciado a emitir NF-e.\r\n* 0 - Não credenciado para emissão da NF-e\r\n* 1 - Credenciado\r\n* 2 - Credenciado com obrigatoriedade para todas operações\r\n* 3 - Credenciado com obrigatoriedade parcial\r\n* 4 - a SEFAZ não fornece a informação\r\nEste indicador significa apenas que o contribuinte é credenciado para emitir NF-e na SEFAZ consultada.","x-nullable":true},"indicador_cte":{"type":"integer","description":"Indicador de contribuinte credenciado a emitir CT-e.\r\n* 0 - Não credenciado para emissão da CT-e\r\n* 1 - Credenciado\r\n* 2 - Credenciado com obrigatoriedade para todas operações\r\n* 3 - Credenciado com obrigatoriedade parcial\r\n* 4 - a SEFAZ não fornece a informação\r\nEste indicador significa apenas que o contribuinte é credenciado para emitir CT-e na SEFAZ consultada.","x-nullable":true},"nome_razao_social":{"type":"string","description":"Razão Social ou nome do contribuinte.","maxLength":60,"minLength":1,"x-nullable":true},"nome_fantasia":{"type":"string","description":"Razão Social ou nome do contribuinte.","maxLength":60,"minLength":1,"x-nullable":true},"regime_apuracao_icms":{"type":"string","description":"Regime de Apuração do ICMS.","maxLength":60,"minLength":1,"x-nullable":true},"cnae":{"type":"string","description":"CNAE Fiscal do contribuinte.","x-nullable":true},"data_inicio_atividade":{"type":"string","format":"date","description":"Data de início de atividades do contribuinte.","x-nullable":true},"data_situacao_cadastral":{"type":"string","format":"date","description":"Data da última modificação da situação cadastral do contribuinte.","x-nullable":true},"data_fim_atividade":{"type":"string","format":"date","description":"Data de ocorrência da baixa do contribuinte.","x-nullable":true},"ie_unica":{"type":"string","description":"Inscrição Estadual Única.","x-nullable":true},"ie_atual":{"type":"string","description":"Inscrição Estadual atual.","x-nullable":true},"endereco":{"$ref":"#/definitions/DfeContribuinteEndereco"}},"required":["nome_razao_social","indicador_cte","indicador_nfe","situacao_cadastral","uf","ie"]},"DfeContribuinteEndereco":{"type":"object","description":"Dados do endereço.","properties":{"logradouro":{"type":"string","description":"Logradouro.","maxLength":60,"minLength":2,"x-nullable":true},"numero":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"complemento":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"bairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"codigo_municipio":{"type":"string","description":"Código do município (utilizar a tabela do IBGE), informar 9999999 para operações com o exterior.","x-nullable":true},"nome_municipio":{"type":"string","description":"Nome do município, informar EXTERIOR para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"uf":{"type":"string","description":"Sigla da UF, informar EX para operações com o exterior.","x-nullable":true},"cep":{"type":"string","description":"CEP.","x-nullable":true},"codigo_pais":{"type":"string","description":"Código de Pais.","x-nullable":true},"pais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone, preencher com Código DDD + número do telefone , nas operações com exterior é permtido informar o código do país + código da localidade + número do telefone.","x-nullable":true}},"required":["uf","nome_municipio","codigo_municipio","bairro","numero","logradouro"]},"NfePedidoEmissaoLote":{"type":"object","properties":{"documentos":{"type":"array","items":{"$ref":"#/definitions/NfePedidoEmissao"},"maxItems":50,"minItems":1},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50},"id_lote":{"type":"string"}},"required":["id_lote","ambiente","documentos"]},"NfePedidoEmissao":{"type":"object","properties":{"infNFe":{"$ref":"#/definitions/NfeSefazInfNFe"},"infNFeSupl":{"$ref":"#/definitions/NfeSefazInfNFeSupl"},"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"referencia":{"type":"string","description":"Seu identificador único para este documento. Opcional, ajuda a evitar o envio duplicado de um mesmo documento.","maxLength":50,"x-nullable":true}},"required":["ambiente","infNFe"]},"NfeSefazInfNFe":{"type":"object","description":"Informações da Nota Fiscal eletrônica.","properties":{"versao":{"type":"string","description":"Versão do leiaute (v4.00).","x-nullable":true},"Id":{"type":"string","description":"PL_005d - 11/08/09 - validação do Id.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"ide":{"$ref":"#/definitions/NfeSefazIde"},"emit":{"$ref":"#/definitions/NfeSefazEmit"},"avulsa":{"$ref":"#/definitions/NfeSefazAvulsa"},"dest":{"$ref":"#/definitions/NfeSefazDest"},"retirada":{"$ref":"#/definitions/NfeSefazLocal"},"entrega":{"$ref":"#/definitions/NfeSefazLocal"},"autXML":{"type":"array","items":{"$ref":"#/definitions/NfeSefazAutXML"},"maxItems":10},"det":{"type":"array","items":{"$ref":"#/definitions/NfeSefazDet"},"maxItems":990,"minItems":1},"total":{"$ref":"#/definitions/NfeSefazTotal"},"transp":{"$ref":"#/definitions/NfeSefazTransp"},"cobr":{"$ref":"#/definitions/NfeSefazCobr"},"pag":{"$ref":"#/definitions/NfeSefazPag"},"infIntermed":{"$ref":"#/definitions/NfeSefazInfIntermed"},"infAdic":{"$ref":"#/definitions/NfeSefazInfAdic"},"exporta":{"$ref":"#/definitions/NfeSefazExporta"},"compra":{"$ref":"#/definitions/NfeSefazCompra"},"cana":{"$ref":"#/definitions/NfeSefazCana"},"infRespTec":{"$ref":"#/definitions/NfeSefazInfRespTec"},"infSolicNFF":{"$ref":"#/definitions/NfeSefazInfSolicNFF"},"agropecuario":{"$ref":"#/definitions/NfeSefazAgropecuario"}},"required":["pag","transp","total","det","emit","ide","versao"]},"NfeSefazIde":{"type":"object","description":"identificação da NF-e.","properties":{"cUF":{"type":"integer","description":"Código da UF do emitente do Documento Fiscal. Utilizar a Tabela do IBGE.","x-nullable":true},"cNF":{"type":"string","description":"Código numérico que compõe a Chave de Acesso. Número aleatório gerado pelo emitente para cada NF-e.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","x-nullable":true},"natOp":{"type":"string","description":"Descrição da Natureza da Operação.","maxLength":60,"minLength":1,"x-nullable":true},"mod":{"type":"integer","description":"Código do modelo do Documento Fiscal:\r\n* 55 - NF-e\r\n* 65 - NFC-e","x-nullable":true},"serie":{"type":"integer","description":"Série do Documento Fiscal:\r\n* Série normal 0-889\r\n* Avulsa Fisco 890-899\r\n* SCAN 900-999","maximum":999,"minimum":0,"x-nullable":true},"nNF":{"type":"integer","description":"Número do Documento Fiscal.","maximum":999999999,"minimum":1,"x-nullable":true},"dhEmi":{"type":"string","format":"date-time","description":"Data e Hora de emissão do Documento Fiscal (AAAA-MM-DDThh:mm:ssTZD) ex.: 2012-09-01T13:00:00-03:00.","x-nullable":true},"dhSaiEnt":{"type":"string","format":"date-time","description":"Data e Hora da saída ou de entrada da mercadoria / produto (AAAA-MM-DDTHH:mm:ssTZD).","x-nullable":true},"dPrevEntrega":{"type":"string","format":"date","description":"Data da previsão de entrega ou disponibilização do bem (AAAA-MM-DD).","x-nullable":true},"tpNF":{"type":"integer","description":"Tipo do Documento Fiscal:\r\n* 0 - Entrada\r\n* 1 - Saída","x-nullable":true},"idDest":{"type":"integer","description":"Identificador de Local de destino da operação:\r\n* 1 - Interna\r\n* 2 - Interestadual\r\n* 3 - Exterior","x-nullable":true},"cMunFG":{"type":"string","description":"Código do Município de Ocorrência do Fato Gerador (utilizar a tabela do IBGE).","x-nullable":true},"cMunFGIBS":{"type":"string","description":"Informar o município de ocorrência do fato gerador do fato gerador do IBS / CBS.\r\nCampo preenchido somente quando “indPres = 5 (Operação presencial, fora do estabelecimento) ”, e não tiver endereço do destinatário (Grupo: E05) ou local de entrega (Grupo: G01).","x-nullable":true},"tpImp":{"type":"integer","description":"Formato de impressão do DANFE:\r\n* 0 - Sem DANFE\r\n* 1 - DANFe Retrato\r\n* 2 - DANFe Paisagem\r\n* 3 - DANFe Simplificado\r\n* 4 - DANFe NFC-e\r\n* 5 - DANFe NFC-e em mensagem eletrônica","x-nullable":true},"tpEmis":{"type":"integer","description":"Forma de emissão da NF-e\r\n* 1 - Normal\r\n* 2 - Contingência FS\r\n* 3 - Regime Especial NFF (NT 2021.002)\r\n* 4 - Contingência DPEC\r\n* 5 - Contingência FSDA\r\n* 6 - Contingência SVC - AN\r\n* 7 - Contingência SVC - RS\r\n* 9 - Contingência off-line NFC-e","x-nullable":true},"cDV":{"type":"integer","description":"Digito Verificador da Chave de Acesso da NF-e.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maximum":9,"minimum":0,"x-nullable":true},"tpAmb":{"type":"integer","description":"Identificação do Ambiente:\r\n* 1 - Produção\r\n* 2 - Homologação","x-nullable":true},"finNFe":{"type":"integer","description":"Finalidade da emissão da NF-e:\r\n* 1 - NFe normal\r\n* 2 - NFe complementar\r\n* 3 - NFe de ajuste\r\n* 4 - Devolução/Retorno\r\n* 5 - Nota de crédito\r\n* 6 - Nota de débito","x-nullable":true},"tpNFDebito":{"type":"string","description":"Tipo de Nota de Débito.","x-nullable":true},"tpNFCredito":{"type":"string","description":"Tipo de Nota de Crédito.","x-nullable":true},"indFinal":{"type":"integer","description":"Indica operação com consumidor final:\r\n* 0 - Não\r\n* 1 - Consumidor Final","x-nullable":true},"indPres":{"type":"integer","description":"Indicador de presença do comprador no estabelecimento comercial no momento da operação:\r\n* 0 - Não se aplica (ex.: Nota Fiscal complementar ou de ajuste)\r\n* 1 - Operação presencial\r\n* 2 - Não presencial, internet\r\n* 3 - Não presencial, teleatendimento\r\n* 4 - NFC-e entrega em domicílio\r\n* 5 - Operação presencial, fora do estabelecimento\r\n* 9 - Não presencial, outros","x-nullable":true},"indIntermed":{"type":"integer","description":"Indicador de intermediador/marketplace\r\n* 0 - Operação sem intermediador (em site ou plataforma própria)\r\n* 1 - Operação em site ou plataforma de terceiros (intermediadores/marketplace)","x-nullable":true},"procEmi":{"type":"integer","description":"Processo de emissão utilizado com a seguinte codificação:\r\n* 0 - emissão de NF-e com aplicativo do contribuinte\r\n* 1 - emissão de NF-e avulsa pelo Fisco\r\n* 2 - emissão de NF-e avulsa, pelo contribuinte com seu certificado digital, através do site\r\ndo Fisco\r\n* 3 - emissão de NF-e pelo contribuinte com aplicativo fornecido pelo Fisco","x-nullable":true},"verProc":{"type":"string","description":"versão do aplicativo utilizado no processo de\r\nemissão.","maxLength":20,"minLength":1,"x-nullable":true},"dhCont":{"type":"string","format":"date-time","description":"Informar a data e hora de entrada em contingência contingência no formato  (AAAA-MM-DDThh:mm:ssTZD) ex.: 2012-09-01T13:00:00-03:00.","x-nullable":true},"xJust":{"type":"string","description":"Informar a Justificativa da entrada.","maxLength":256,"minLength":15,"x-nullable":true},"NFref":{"type":"array","items":{"$ref":"#/definitions/NfeSefazNFref"},"maxItems":999},"gCompraGov":{"$ref":"#/definitions/NfeSefazCompraGov"},"gPagAntecipado":{"$ref":"#/definitions/NfeSefazGPagAntecipado"}},"required":["verProc","procEmi","indPres","indFinal","finNFe","tpEmis","tpImp","cMunFG","idDest","tpNF","dhEmi","nNF","serie","natOp","cUF"]},"NfeSefazNFref":{"type":"object","description":"Grupo de infromações da NF referenciada.","properties":{"refNFe":{"type":"string","description":"Chave de acesso das NF-e referenciadas. Chave de acesso compostas por Código da UF (tabela do IBGE) + AAMM da emissão + CNPJ do Emitente + modelo, série e número da NF-e Referenciada + Código Numérico + DV.","maxLength":44,"x-nullable":true},"refNFeSig":{"type":"string","description":"Referencia uma NF-e (modelo 55) emitida anteriormente pela sua Chave de Acesso com código numérico zerado, permitindo manter o sigilo da NF-e referenciada.","maxLength":44,"x-nullable":true},"refNF":{"$ref":"#/definitions/NfeSefazRefNF"},"refNFP":{"$ref":"#/definitions/NfeSefazRefNFP"},"refCTe":{"type":"string","description":"Utilizar esta TAG para referenciar um CT-e emitido anteriormente, vinculada a NF-e atual.","maxLength":44,"x-nullable":true},"refECF":{"$ref":"#/definitions/NfeSefazRefECF"}}},"NfeSefazRefNF":{"type":"object","description":"Dados da NF modelo 1/1A referenciada ou NF modelo 2 referenciada.","properties":{"cUF":{"type":"integer","description":"Código da UF do emitente do Documento Fiscal. Utilizar a Tabela do IBGE.","x-nullable":true},"AAMM":{"type":"string","description":"AAMM da emissão.","x-nullable":true},"CNPJ":{"type":"string","description":"CNPJ do emitente do documento fiscal referenciado.","maxLength":14,"x-nullable":true},"mod":{"type":"string","description":"Código do modelo do Documento Fiscal. Utilizar 01 para NF modelo 1/1A e 02 para NF modelo 02.","x-nullable":true},"serie":{"type":"integer","description":"Série do Documento Fiscal, informar zero se inexistente.","maximum":999,"minimum":0,"x-nullable":true},"nNF":{"type":"integer","description":"Número do Documento Fiscal.","maximum":999999999,"minimum":1,"x-nullable":true}},"required":["nNF","serie","mod","CNPJ","AAMM","cUF"]},"NfeSefazRefNFP":{"type":"object","description":"Grupo com as informações NF de produtor referenciada.","properties":{"cUF":{"type":"integer","description":"Código da UF do emitente do Documento FiscalUtilizar a Tabela do IBGE (Anexo IV - Tabela de UF, Município e País).","x-nullable":true},"AAMM":{"type":"string","description":"AAMM da emissão da NF de produtor.","x-nullable":true},"CNPJ":{"type":"string","description":"CNPJ do emitente da NF de produtor.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"CPF do emitente da NF de produtor.","maxLength":11,"x-nullable":true},"IE":{"type":"string","description":"IE do emitente da NF de Produtor.","maxLength":14,"x-nullable":true},"mod":{"type":"string","description":"Código do modelo do Documento Fiscal - utilizar 04 para NF de produtor  ou 01 para NF Avulsa.","x-nullable":true},"serie":{"type":"integer","description":"Série do Documento Fiscal, informar zero se inexistentesérie.","maximum":999,"minimum":0,"x-nullable":true},"nNF":{"type":"integer","description":"Número do Documento Fiscal - 1 - 999999999.","maximum":999999999,"minimum":1,"x-nullable":true}},"required":["nNF","serie","mod","IE","AAMM","cUF"]},"NfeSefazRefECF":{"type":"object","description":"Grupo do Cupom Fiscal vinculado à NF-e.","properties":{"mod":{"type":"string","description":"Código do modelo do Documento Fiscal\r\nPreencher com \"2B\", quando se tratar de Cupom Fiscal emitido por máquina registradora (não ECF), com \"2C\", quando se tratar de Cupom Fiscal PDV, ou \"2D\", quando se tratar de Cupom Fiscal (emitido por ECF).","x-nullable":true},"nECF":{"type":"integer","description":"Informar o número de ordem seqüencial do ECF que emitiu o Cupom Fiscal vinculado à NF-e.","maximum":999,"minimum":0,"x-nullable":true},"nCOO":{"type":"integer","description":"Informar o Número do Contador de Ordem de Operação - COO vinculado à NF-e.","maximum":999999,"minimum":0,"x-nullable":true}},"required":["nCOO","nECF","mod"]},"NfeSefazCompraGov":{"type":"object","description":"Grupo de Compras Governamentais.","properties":{"tpEnteGov":{"type":"integer","description":"Para administração pública direta e suas autarquias e fundações:\r\n* 1 - União\r\n* 2 - Estados\r\n* 3 - Distrito Federal\r\n* 4 - Municípios","x-nullable":true},"pRedutor":{"type":"number","description":"Percentual de redução de aliquota em compra governamental.","minimum":0,"x-nullable":true},"tpOperGov":{"type":"integer","description":"Tipo da operação com ente governamental:\r\n* 1 - Fornecimento\r\n* 2 - Recebimento do Pagamento","x-nullable":true}},"required":["tpOperGov","pRedutor","tpEnteGov"]},"NfeSefazGPagAntecipado":{"type":"object","description":"Informado para abater as parcelas de antecipação de pagamento, conforme Art. 10. § 4º.","properties":{"refNFe":{"type":"array","description":"Chave de acesso da NF-e de antecipação de pagamento.","items":{"type":"string"},"maxItems":99,"minItems":1}},"required":["refNFe"]},"NfeSefazEmit":{"type":"object","description":"Identificação do emitente.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ do emitente.\r\n\r\n***Obrigatório caso o emitente seja pessoa jurídica***.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF do emitente.\r\n\r\n***Obrigatorio caso o emitente seja pessoa física***.","maxLength":11,"x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"xFant":{"type":"string","description":"Nome fantasia.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"enderEmit":{"$ref":"#/definitions/NfeSefazEnderEmi"},"IE":{"type":"string","description":"Inscrição Estadual do Emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":14,"x-nullable":true},"IEST":{"type":"string","description":"Inscricao Estadual do Substituto Tributário.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":14,"x-nullable":true},"IM":{"type":"string","description":"Inscrição Municipal.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":15,"minLength":1,"x-nullable":true},"CNAE":{"type":"string","description":"CNAE Fiscal.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"CRT":{"type":"integer","description":"Código de Regime Tributário.\r\nEste campo será obrigatoriamente preenchido com:\r\n* 1 - Simples Nacional\r\n* 2 - Simples Nacional - excesso de sublimite de receita bruta\r\n* 3 - Regime Normal\r\n* 4 - Simples Nacional - Microempreendedor individual - MEI\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"NfeSefazEnderEmi":{"type":"object","description":"Endereço do emitente.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","properties":{"xLgr":{"type":"string","description":"Logradouro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","maxLength":60,"minLength":2,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"CEP":{"type":"string","description":"CEP - NT 2011/004.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"cPais":{"type":"string","description":"Código do país.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true},"fone":{"type":"string","description":"Preencher com Código DDD + número do telefone (v.2.0).\r\n\r\n*Caso não seja informado, será utilizado o do cadastro da empresa.*","x-nullable":true}}},"NfeSefazAvulsa":{"type":"object","description":"Emissão de avulsa, informar os dados do Fisco emitente.","properties":{"CNPJ":{"type":"string","description":"CNPJ do Órgão emissor.","maxLength":14,"x-nullable":true},"xOrgao":{"type":"string","description":"Órgão emitente.","maxLength":60,"minLength":1,"x-nullable":true},"matr":{"type":"string","description":"Matrícula do agente.","maxLength":60,"minLength":1,"x-nullable":true},"xAgente":{"type":"string","description":"Nome do agente.","maxLength":60,"minLength":1,"x-nullable":true},"fone":{"type":"string","description":"Telefone.","x-nullable":true},"UF":{"type":"string","description":"Sigla da Unidade da Federação.","x-nullable":true},"nDAR":{"type":"string","description":"Número do Documento de Arrecadação de Receita.","maxLength":60,"minLength":1,"x-nullable":true},"dEmi":{"type":"string","format":"date","description":"Data de emissão do DAR (AAAA-MM-DD).","x-nullable":true},"vDAR":{"type":"number","description":"Valor Total constante no DAR.","minimum":0,"x-nullable":true},"repEmi":{"type":"string","description":"Repartição Fiscal emitente.","maxLength":60,"minLength":1,"x-nullable":true},"dPag":{"type":"string","format":"date","description":"Data de pagamento do DAR (AAAA-MM-DD).","x-nullable":true}},"required":["repEmi","UF","xAgente","matr","xOrgao","CNPJ"]},"NfeSefazDest":{"type":"object","description":"Identificação do Destinatário.","properties":{"CNPJ":{"type":"string","description":"Número do CNPJ.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"Número do CPF.","maxLength":11,"x-nullable":true},"idEstrangeiro":{"type":"string","description":"Identificador do destinatário, em caso de comprador estrangeiro.","x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou nome do destinatário.","maxLength":60,"minLength":2,"x-nullable":true},"enderDest":{"$ref":"#/definitions/NfeSefazEndereco"},"indIEDest":{"type":"integer","description":"Indicador da IE do destinatário:\r\n* 1 - Contribuinte ICMSpagamento à vista\r\n* 2 - Contribuinte isento de inscrição\r\n* 9 - Não Contribuinte","x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual (obrigatório nas operações com contribuintes do ICMS).","maxLength":14,"x-nullable":true},"ISUF":{"type":"string","description":"Inscrição na SUFRAMA (Obrigatório nas operações com as áreas com benefícios de incentivos fiscais sob controle da SUFRAMA) PL_005d - 11/08/09 - alterado para aceitar 8 ou 9 dígitos.","x-nullable":true},"IM":{"type":"string","description":"Inscrição Municipal do tomador do serviço.","maxLength":15,"minLength":1,"x-nullable":true},"email":{"type":"string","description":"Informar o e-mail do destinatário. O campo pode ser utilizado para informar o e-mail\r\nde recepção da NF-e indicada pelo destinatário.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["indIEDest"]},"NfeSefazEndereco":{"type":"object","description":"Dados do endereço.","properties":{"xLgr":{"type":"string","description":"Logradouro.","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE), informar 9999999 para operações com o exterior.","x-nullable":true},"xMun":{"type":"string","description":"Nome do município, informar EXTERIOR para operações com o exterior.","maxLength":60,"minLength":2,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF, informar EX para operações com o exterior.","x-nullable":true},"CEP":{"type":"string","description":"CEP.","x-nullable":true},"cPais":{"type":"string","description":"Código de Pais.","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone, preencher com Código DDD + número do telefone , nas operações com exterior é permtido informar o código do país + código da localidade + número do telefone.","x-nullable":true}},"required":["UF","xMun","cMun","xBairro","nro","xLgr"]},"NfeSefazLocal":{"type":"object","description":"Identificação do local de retirada/entrega (informar apenas quando for diferente do endereço do remetente/destinatário)","properties":{"CNPJ":{"type":"string","description":"CNPJ.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"CPF (v2.0).","maxLength":11,"x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou Nome do Expedidor/Recebedor.","maxLength":60,"minLength":2,"x-nullable":true},"xLgr":{"type":"string","description":"Logradouro.","maxLength":60,"minLength":2,"x-nullable":true},"nro":{"type":"string","description":"Número.","maxLength":60,"minLength":1,"x-nullable":true},"xCpl":{"type":"string","description":"Complemento.","maxLength":60,"minLength":1,"x-nullable":true},"xBairro":{"type":"string","description":"Bairro.","maxLength":60,"minLength":2,"x-nullable":true},"cMun":{"type":"string","description":"Código do município (utilizar a tabela do IBGE).","x-nullable":true},"xMun":{"type":"string","description":"Nome do município.","maxLength":60,"minLength":2,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.","x-nullable":true},"CEP":{"type":"string","description":"CEP.","x-nullable":true},"cPais":{"type":"string","description":"Código de Pais.","x-nullable":true},"xPais":{"type":"string","description":"Nome do país.","maxLength":60,"minLength":2,"x-nullable":true},"fone":{"type":"string","description":"Telefone, preencher com Código DDD + número do telefone , nas operações com exterior é permtido informar o código do país + código da localidade + número do telefone.","x-nullable":true},"email":{"type":"string","description":"Informar o e-mail do expedidor/Recebedor. O campo pode ser utilizado para informar o e-mail de recepção da NF-e indicada pelo expedidor.","maxLength":60,"minLength":1,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual (v2.0).","maxLength":14,"x-nullable":true}},"required":["UF","xMun","cMun","xBairro","nro","xLgr"]},"NfeSefazAutXML":{"type":"object","description":"Pessoas autorizadas para o download do XML da NF-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ Autorizado.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"CPF Autorizado.","maxLength":11,"x-nullable":true}}},"NfeSefazDet":{"type":"object","description":"Dados dos detalhes da NF-e.","properties":{"nItem":{"type":"integer","description":"Número do item do NF.","maximum":990,"minimum":1,"x-nullable":true},"prod":{"$ref":"#/definitions/NfeSefazProd"},"imposto":{"$ref":"#/definitions/NfeSefazImposto"},"impostoDevol":{"$ref":"#/definitions/NfeSefazImpostoDevol"},"infAdProd":{"type":"string","description":"Informações adicionais do produto (norma referenciada, informações complementares, etc).","maxLength":500,"minLength":1,"x-nullable":true},"obsItem":{"$ref":"#/definitions/NfeSefazObsItem"},"vItem":{"type":"number","description":"Valor total do Item, correspondente à sua participação no total da nota. A soma dos itens deverá corresponder ao total da nota.","minimum":0,"x-nullable":true},"DFeReferenciado":{"$ref":"#/definitions/NfeSefazDFeReferenciado"}},"required":["imposto","prod","nItem"]},"NfeSefazProd":{"type":"object","description":"Dados dos produtos e serviços da NF-e.","properties":{"cProd":{"type":"string","description":"Código do produto ou serviço. Preencher com CFOP caso se trate de itens não relacionados com mercadorias/produto e que o contribuinte não possua codificação própria\r\nFormato ”CFOP9999”.","maxLength":60,"minLength":1,"x-nullable":true},"cEAN":{"type":"string","description":"GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras.","x-nullable":true},"cBarra":{"type":"string","description":"Codigo de barras diferente do padrão GTIN.","maxLength":30,"minLength":3,"x-nullable":true},"xProd":{"type":"string","description":"Descrição do produto ou serviço.","maxLength":120,"minLength":1,"x-nullable":true},"NCM":{"type":"string","description":"Código NCM (8 posições), será permitida a informação do gênero (posição do capítulo do NCM) quando a operação não for de comércio exterior (importação/exportação) ou o produto não seja tributado pelo IPI. Em caso de item de serviço ou item que não tenham produto (Ex. transferência de crédito, crédito do ativo imobilizado, etc.), informar o código 00 (zeros) (v2.0).","x-nullable":true},"NVE":{"type":"array","description":"Nomenclatura de Valor aduaneio e Estatístico.","items":{"type":"string"},"maxItems":8},"CEST":{"type":"string","description":"Codigo especificador da Substuicao Tributaria - CEST, que identifica a mercadoria sujeita aos regimes de  substituicao tributária e de antecipação do recolhimento  do imposto.","x-nullable":true},"indEscala":{"type":"string","x-nullable":true},"CNPJFab":{"type":"string","description":"CNPJ do Fabricante da Mercadoria, obrigatório para produto em escala NÃO relevante.","maxLength":14,"x-nullable":true},"cBenef":{"type":"string","x-nullable":true},"gCred":{"type":"array","items":{"$ref":"#/definitions/NfeSefazGCred"},"maxItems":4},"tpCredPresIBSZFM":{"type":"integer","description":"Classificação para subapuração do IBS na ZFM.","x-nullable":true},"EXTIPI":{"type":"string","description":"Código EX TIPI (3 posições).","x-nullable":true},"CFOP":{"type":"string","description":"Cfop.","x-nullable":true},"uCom":{"type":"string","description":"Unidade comercial.","maxLength":6,"minLength":1,"x-nullable":true},"qCom":{"type":"number","description":"Quantidade Comercial  do produto, alterado para aceitar de 0 a 4 casas decimais e 11 inteiros.","minimum":0,"x-nullable":true},"vUnCom":{"type":"number","description":"Valor unitário de comercialização  - alterado para aceitar 0 a 10 casas decimais e 11 inteiros.","minimum":0,"x-nullable":true},"vProd":{"type":"number","description":"Valor bruto do produto ou serviço.","minimum":0,"x-nullable":true},"cEANTrib":{"type":"string","description":"GTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras.","x-nullable":true},"cBarraTrib":{"type":"string","description":"Código de barras da unidade tributável diferente do padrão GTIN.","maxLength":30,"minLength":3,"x-nullable":true},"uTrib":{"type":"string","description":"Unidade Tributável.","maxLength":6,"minLength":1,"x-nullable":true},"qTrib":{"type":"number","description":"Quantidade Tributável - alterado para aceitar de 0 a 4 casas decimais e 11 inteiros.","minimum":0,"x-nullable":true},"vUnTrib":{"type":"number","description":"Valor unitário de tributação - alterado para aceitar 0 a 10 casas decimais e 11 inteiros.","minimum":0,"x-nullable":true},"vFrete":{"type":"number","description":"Valor Total do Frete.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vSeg":{"type":"number","description":"Valor Total do Seguro.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDesc":{"type":"number","description":"Valor do Desconto.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vOutro":{"type":"number","description":"Outras despesas acessórias.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"indTot":{"type":"integer","description":"Este campo deverá ser preenchido com:\r\n* 0 - o valor do item (vProd) não compõe o valor total da NF-e (vProd)\r\n* 1 - o valor do item (vProd) compõe o valor total da NF-e (vProd)","x-nullable":true},"indBemMovelUsado":{"type":"integer","description":"Indicador de fornecimento de bem móvel usado: 1-Bem Móvel Usado.","x-nullable":true},"DI":{"type":"array","items":{"$ref":"#/definitions/NfeSefazDI"},"maxItems":100},"detExport":{"type":"array","items":{"$ref":"#/definitions/NfeSefazDetExport"},"maxItems":500},"xPed":{"type":"string","description":"pedido de compra - Informação de interesse do emissor para controle do B2B.","maxLength":15,"minLength":1,"x-nullable":true},"nItemPed":{"type":"integer","description":"Número do Item do Pedido de Compra - Identificação do número do item do pedido de Compra.","maximum":999999,"minimum":0,"x-nullable":true},"nFCI":{"type":"string","description":"Número de controle da FCI - Ficha de Conteúdo de Importação.","x-nullable":true},"rastro":{"type":"array","items":{"$ref":"#/definitions/NfeSefazRastro"},"maxItems":500},"infProdNFF":{"$ref":"#/definitions/NfeSefazInfProdNFF"},"infProdEmb":{"$ref":"#/definitions/NfeSefazInfProdEmb"},"veicProd":{"$ref":"#/definitions/NfeSefazVeicProd"},"med":{"$ref":"#/definitions/NfeSefazMed"},"arma":{"type":"array","items":{"$ref":"#/definitions/NfeSefazArma"},"maxItems":500},"comb":{"$ref":"#/definitions/NfeSefazComb"},"nRECOPI":{"type":"string","description":"Número do RECOPI.","maxLength":20,"x-nullable":true}},"required":["indTot","vUnTrib","qTrib","uTrib","cEANTrib","vProd","vUnCom","qCom","uCom","CFOP","NCM","xProd","cEAN","cProd"]},"NfeSefazGCred":{"type":"object","description":"Grupo de informações sobre o CréditoPresumido.","properties":{"cCredPresumido":{"type":"string","description":"Código de Benefício Fiscal de Crédito Presumido na UF aplicado ao item.","x-nullable":true},"pCredPresumido":{"type":"number","description":"Percentual do Crédito Presumido.","minimum":0,"x-nullable":true},"vCredPresumido":{"type":"number","description":"Valor do Crédito Presumido.","minimum":0,"x-nullable":true}},"required":["vCredPresumido","pCredPresumido","cCredPresumido"]},"NfeSefazDI":{"type":"object","description":"Declaração de Importação (NT 2011/004).","properties":{"nDI":{"type":"string","description":"Número do Documento de Importação (DI, DSI, DIRE, DUImp) (NT2011/004).","maxLength":15,"minLength":1,"x-nullable":true},"dDI":{"type":"string","format":"date","description":"Data de registro da DI/DSI/DA (AAAA-MM-DD).","x-nullable":true},"xLocDesemb":{"type":"string","description":"Local do desembaraço aduaneiro.","maxLength":60,"minLength":1,"x-nullable":true},"UFDesemb":{"type":"string","description":"UF onde ocorreu o desembaraço aduaneiro.","x-nullable":true},"dDesemb":{"type":"string","format":"date","description":"Data do desembaraço aduaneiro (AAAA-MM-DD).","x-nullable":true},"tpViaTransp":{"type":"integer","description":"Via de transporte internacional informada na DI ou na Declaração Única de Importação (DUImp):\r\n* 1 - Maritima\r\n* 2 - Fluvial\r\n* 3 - Lacustre\r\n* 4 - Aerea\r\n* 5 - Postal\r\n* 6 - Ferroviaria\r\n* 7 - Rodoviaria\r\n* 8 - Conduto\r\n* 9 - Meios Proprios\r\n* 10 - Entrada/Saida Ficta\r\n* 11 - Courier\r\n* 12 - Em maos\r\n* 13 - Por reboque","x-nullable":true},"vAFRMM":{"type":"number","description":"Valor Adicional ao frete para renovação de marinha mercante.","minimum":0,"x-nullable":true},"tpIntermedio":{"type":"integer","description":"Forma de Importação quanto a intermediação\r\n* 1 - por conta propria\r\n* 2 - por conta e ordem\r\n* 3 - encomenda","x-nullable":true},"CNPJ":{"type":"string","description":"CNPJ do adquirente ou do encomendante.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"CPF do adquirente ou do encomendante.","maxLength":11,"x-nullable":true},"UFTerceiro":{"type":"string","description":"Sigla da UF do adquirente ou do encomendante.","x-nullable":true},"cExportador":{"type":"string","description":"Código do exportador (usado nos sistemas internos de informação do emitente da NF-e).","maxLength":60,"minLength":1,"x-nullable":true},"adi":{"type":"array","items":{"$ref":"#/definitions/NfeSefazAdi"},"maxItems":999,"minItems":1}},"required":["adi","cExportador","tpIntermedio","tpViaTransp","dDesemb","UFDesemb","xLocDesemb","dDI","nDI"]},"NfeSefazAdi":{"type":"object","description":"Adições (NT 2011/004).","properties":{"nAdicao":{"type":"integer","description":"Número da Adição.","maximum":999,"minimum":1,"x-nullable":true},"nSeqAdic":{"type":"integer","description":"Número seqüencial do item.","maximum":99999,"minimum":1,"x-nullable":true},"cFabricante":{"type":"string","description":"Código do fabricante estrangeiro (usado nos sistemas internos de informação do emitente da NF-e).","maxLength":60,"minLength":1,"x-nullable":true},"vDescDI":{"type":"number","description":"Valor do desconto do item.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"nDraw":{"type":"string","description":"Número do ato concessório de Drawback.","maxLength":20,"minLength":1,"x-nullable":true}},"required":["cFabricante","nSeqAdic"]},"NfeSefazDetExport":{"type":"object","description":"Detalhe da exportação.","properties":{"nDraw":{"type":"string","description":"Número do ato concessório de Drawback.","maxLength":20,"minLength":1,"x-nullable":true},"exportInd":{"$ref":"#/definitions/NfeSefazExportInd"}}},"NfeSefazExportInd":{"type":"object","description":"Exportação indireta.","properties":{"nRE":{"type":"string","description":"Registro de exportação.","x-nullable":true},"chNFe":{"type":"string","description":"Chave de acesso da NF-e recebida para exportação.","maxLength":44,"x-nullable":true},"qExport":{"type":"number","description":"Quantidade do item efetivamente exportado.","minimum":0,"x-nullable":true}},"required":["qExport","chNFe","nRE"]},"NfeSefazRastro":{"type":"object","properties":{"nLote":{"type":"string","description":"Número do lote do produto.","maxLength":20,"minLength":1,"x-nullable":true},"qLote":{"type":"number","description":"Quantidade de produto no lote.","minimum":0,"x-nullable":true},"dFab":{"type":"string","format":"date","description":"Data de fabricação/produção. Formato \"AAAA-MM-DD\".","x-nullable":true},"dVal":{"type":"string","format":"date","description":"Data de validade. Informar o último dia do mês caso a validade não especifique o dia. Formato \"AAAA-MM-DD\".","x-nullable":true},"cAgreg":{"type":"string","maxLength":20,"minLength":1,"x-nullable":true}},"required":["dVal","dFab","qLote","nLote"]},"NfeSefazInfProdNFF":{"type":"object","description":"Informações mais detalhadas do produto (usada na NFF).","properties":{"cProdFisco":{"type":"string","description":"Código Fiscal do Produto.","maxLength":14,"x-nullable":true},"cOperNFF":{"type":"string","description":"Código da operação selecionada na NFF e relacionada ao item.","x-nullable":true}},"required":["cOperNFF","cProdFisco"]},"NfeSefazInfProdEmb":{"type":"object","description":"Informações mais detalhadas do produto (usada na NFF).","properties":{"xEmb":{"type":"string","description":"Embalagem do produto.","maxLength":8,"minLength":1,"x-nullable":true},"qVolEmb":{"type":"number","description":"Volume do produto na embalagem.","minimum":0,"x-nullable":true},"uEmb":{"type":"string","description":"Unidade de Medida da Embalagem.","maxLength":8,"minLength":1,"x-nullable":true}},"required":["uEmb","qVolEmb","xEmb"]},"NfeSefazVeicProd":{"type":"object","description":"Veículos novos.","properties":{"tpOp":{"type":"integer","description":"Tipo da Operação (1 - Venda concessionária; 2 - Faturamento direto; 3 - Venda direta; 0 - Outros).","x-nullable":true},"chassi":{"type":"string","description":"Chassi do veículo - VIN (código-identificação-veículo).","maxLength":17,"x-nullable":true},"cCor":{"type":"string","description":"Cor do veículo (código de cada montadora).","maxLength":4,"minLength":1,"x-nullable":true},"xCor":{"type":"string","description":"Descrição da cor.","maxLength":40,"minLength":1,"x-nullable":true},"pot":{"type":"string","description":"Potência máxima do motor do veículo em cavalo vapor (CV). (potência-veículo).","maxLength":4,"minLength":1,"x-nullable":true},"cilin":{"type":"string","description":"Capacidade voluntária do motor expressa em centímetros cúbicos (CC). (cilindradas).","maxLength":4,"minLength":1,"x-nullable":true},"pesoL":{"type":"string","description":"Peso líquido.","maxLength":9,"minLength":1,"x-nullable":true},"pesoB":{"type":"string","description":"Peso bruto.","maxLength":9,"minLength":1,"x-nullable":true},"nSerie":{"type":"string","description":"Serial (série).","maxLength":9,"minLength":1,"x-nullable":true},"tpComb":{"type":"string","description":"Tipo de combustível-Tabela RENAVAM: 01-Álcool\r\n* 02 - Gasolina\r\n* 03 - Diesel\r\n* 16 - Álcool/Gas\r\n* 17 - Gas./Álcool/GNV\r\n* 18 - Gasolina/Elétrico","maxLength":2,"minLength":1,"x-nullable":true},"nMotor":{"type":"string","description":"Número do motor.","maxLength":21,"minLength":1,"x-nullable":true},"CMT":{"type":"string","description":"CMT-Capacidade Máxima de Tração - em Toneladas 4 casas decimais.","maxLength":9,"minLength":1,"x-nullable":true},"dist":{"type":"string","description":"Distância entre eixos.","maxLength":4,"minLength":1,"x-nullable":true},"anoMod":{"type":"integer","description":"Ano Modelo de Fabricação.","maximum":9999,"minimum":0,"x-nullable":true},"anoFab":{"type":"integer","description":"Ano de Fabricação.","maximum":9999,"minimum":0,"x-nullable":true},"tpPint":{"type":"string","description":"Tipo de pintura.","maxLength":1,"x-nullable":true},"tpVeic":{"type":"integer","description":"Tipo de veículo (utilizar tabela RENAVAM).","maximum":99,"minimum":0,"x-nullable":true},"espVeic":{"type":"integer","description":"Espécie de veículo (utilizar tabela RENAVAM).","maximum":9,"minimum":0,"x-nullable":true},"VIN":{"type":"string","description":"Informa-se o veículo tem VIN (chassi) remarcado.\r\n* R-Remarcado\r\n* N-NormalVIN","maxLength":1,"x-nullable":true},"condVeic":{"type":"integer","description":"Condição do veículo (1 - acabado; 2 - inacabado; 3 - semi-acabado).","x-nullable":true},"cMod":{"type":"string","description":"Código Marca Modelo (utilizar tabela RENAVAM).","x-nullable":true},"cCorDENATRAN":{"type":"string","description":"Código da Cor Segundo as regras de pré-cadastro do DENATRAN: 01-AMARELO\r\n* 02 - AZUL\r\n* 03 - BEGE\r\n* 04 - BRANCA\r\n* 05 - CINZA\r\n* 06 - DOURADA\r\n* 07 - GRENA\r\n* 08 - LARANJA\r\n* 09 - MARROM\r\n* 10 - PRATA\r\n* 11 - PRETA\r\n* 12 - ROSA\r\n* 13 - ROXA\r\n* 14 - VERDE\r\n* 15 - VERMELHA\r\n* 16 - FANTASIA","maxLength":2,"minLength":1,"x-nullable":true},"lota":{"type":"integer","description":"Quantidade máxima de permitida de passageiros sentados, inclusive motorista.","maximum":999,"minimum":0,"x-nullable":true},"tpRest":{"type":"integer","description":"Restrição\r\n* 0 - Não há\r\n* 1 - Alienação Fiduciária\r\n* 2 - Arrendamento Mercantil\r\n* 3 - Reserva de Domínio\r\n* 4 - Penhor de Veículos\r\n* 9 - outras","x-nullable":true}},"required":["tpRest","lota","cCorDENATRAN","cMod","condVeic","VIN","espVeic","tpVeic","tpPint","anoFab","anoMod","dist","CMT","nMotor","tpComb","nSerie","pesoB","pesoL","cilin","pot","xCor","cCor","chassi","tpOp"]},"NfeSefazMed":{"type":"object","description":"grupo do detalhamento de Medicamentos e de matérias-primas farmacêuticas.","properties":{"cProdANVISA":{"type":"string","description":"Utilizar o número do registro ANVISA  ou preencher com o literal “ISENTO”, no caso de medicamento isento de registro na ANVISA.","x-nullable":true},"xMotivoIsencao":{"type":"string","description":"Obs.: Para medicamento isento de registro na ANVISA, informar o número da decisão que o isenta, como por exemplo o número da Resolução da Diretoria Colegiada da ANVISA (RDC).","maxLength":255,"minLength":1,"x-nullable":true},"vPMC":{"type":"number","description":"Preço Máximo ao Consumidor.","minimum":0,"x-nullable":true}},"required":["vPMC","cProdANVISA"]},"NfeSefazArma":{"type":"object","description":"Armamentos.","properties":{"tpArma":{"type":"integer","description":"Indicador do tipo de arma de fogo (0 - Uso permitido; 1 - Uso restrito).","x-nullable":true},"nSerie":{"type":"string","description":"Número de série da arma.","maxLength":15,"minLength":1,"x-nullable":true},"nCano":{"type":"string","description":"Número de série do cano.","maxLength":15,"minLength":1,"x-nullable":true},"descr":{"type":"string","description":"Descrição completa da arma, compreendendo: calibre, marca, capacidade, tipo de funcionamento, comprimento e demais elementos que permitam a sua perfeita identificação.","maxLength":256,"minLength":1,"x-nullable":true}},"required":["descr","nCano","nSerie","tpArma"]},"NfeSefazComb":{"type":"object","description":"Informar apenas para operações com combustíveis líquidos.","properties":{"cProdANP":{"type":"integer","description":"Código de produto da ANP. codificação de produtos do SIMP (http://www.anp.gov.br).","maximum":999999999,"minimum":0,"x-nullable":true},"descANP":{"type":"string","description":"Descrição do Produto conforme ANP. Utilizar a descrição de produtos do Sistema de Informações de Movimentação de Produtos - SIMP (http://www.anp.gov.br/simp/).","maxLength":95,"minLength":2,"x-nullable":true},"pGLP":{"type":"number","description":"Percentual do GLP derivado do petróleo no produto GLP (cProdANP=210203001). Informar em número decimal o percentual do GLP derivado de petróleo no produto GLP. Valores 0 a 100.","maximum":100,"minimum":0,"x-nullable":true},"pGNn":{"type":"number","description":"Percentual de gás natural nacional - GLGNn para o produto GLP (cProdANP=210203001). Informar em número decimal o percentual do Gás Natural Nacional - GLGNn para o produto GLP. Valores de 0 a 100.","maximum":100,"minimum":0,"x-nullable":true},"pGNi":{"type":"number","description":"Percentual de gás natural importado GLGNi para o produto GLP (cProdANP=210203001). Informar em número deciaml o percentual do Gás Natural Importado - GLGNi para o produto GLP. Valores de 0 a 100.","maximum":100,"minimum":0,"x-nullable":true},"vPart":{"type":"number","description":"Valor de partida (cProdANP=210203001). Deve ser informado neste campo o valor por quilograma sem ICMS.","minimum":0,"x-nullable":true},"CODIF":{"type":"string","description":"Código de autorização / registro do CODIF. Informar apenas quando a UF utilizar o CODIF (Sistema de Controle do \t\t\tDiferimento do Imposto nas Operações com AEAC - Álcool Etílico Anidro Combustível).","x-nullable":true},"qTemp":{"type":"number","description":"Quantidade de combustível\r\nfaturada à temperatura ambiente.\r\nInformar quando a quantidade\r\nfaturada informada no campo\r\nqCom (I10) tiver sido ajustada para\r\numa temperatura diferente da\r\nambiente.","minimum":0,"x-nullable":true},"UFCons":{"type":"string","description":"Sigla da UF de Consumo.","x-nullable":true},"CIDE":{"$ref":"#/definitions/NfeSefazCIDE"},"encerrante":{"$ref":"#/definitions/NfeSefazEncerrante"},"pBio":{"type":"number","description":"Percentual do índice de mistura do Biodiesel (B100) no Óleo Diesel B instituído pelo órgão regulamentador.","maximum":100,"minimum":0,"exclusiveMinimum":true,"x-nullable":true},"origComb":{"type":"array","items":{"$ref":"#/definitions/NfeSefazOrigComb"},"maxItems":30}},"required":["UFCons","descANP","cProdANP"]},"NfeSefazCIDE":{"type":"object","description":"CIDE Combustíveis.","properties":{"qBCProd":{"type":"number","description":"BC do CIDE ( Quantidade comercializada).","minimum":0,"x-nullable":true},"vAliqProd":{"type":"number","description":"Alíquota do CIDE  (em reais).","minimum":0,"x-nullable":true},"vCIDE":{"type":"number","description":"Valor do CIDE.","minimum":0,"x-nullable":true}},"required":["vCIDE","vAliqProd","qBCProd"]},"NfeSefazEncerrante":{"type":"object","description":"Informações do grupo de \"encerrante\".","properties":{"nBico":{"type":"integer","description":"Numero de identificação do Bico utilizado no abastecimento.","maximum":999,"minimum":0,"x-nullable":true},"nBomba":{"type":"integer","description":"Numero de identificação da bomba ao qual o bico está interligado.","maximum":999,"minimum":0,"x-nullable":true},"nTanque":{"type":"integer","description":"Numero de identificação do tanque ao qual o bico está interligado.","maximum":999,"minimum":0,"x-nullable":true},"vEncIni":{"type":"number","description":"Valor do Encerrante no ínicio do abastecimento.","minimum":0,"x-nullable":true},"vEncFin":{"type":"number","description":"Valor do Encerrante no final do abastecimento.","minimum":0,"x-nullable":true}},"required":["vEncFin","vEncIni","nTanque","nBico"]},"NfeSefazOrigComb":{"type":"object","description":"Grupo indicador da origem do combustível.","properties":{"indImport":{"type":"integer","description":"Indicador de importação 0=Nacional\r\n* 1 - Importado","x-nullable":true},"cUFOrig":{"type":"integer","description":"UF de origem do produtor ou do importado.","x-nullable":true},"pOrig":{"type":"number","description":"Percentual originário para a UF.","maximum":100,"minimum":0,"exclusiveMinimum":true,"x-nullable":true}},"required":["pOrig","cUFOrig","indImport"]},"NfeSefazImposto":{"type":"object","description":"Tributos incidentes nos produtos ou serviços da NF-e.","properties":{"vTotTrib":{"type":"number","description":"Valor estimado total de impostos federais, estaduais e municipais.","minimum":0,"x-nullable":true},"ICMS":{"$ref":"#/definitions/NfeSefazICMS"},"IPI":{"$ref":"#/definitions/NfeSefazIpi"},"II":{"$ref":"#/definitions/NfeSefazII"},"ISSQN":{"$ref":"#/definitions/NfeSefazISSQN"},"PIS":{"$ref":"#/definitions/NfeSefazPIS"},"PISST":{"$ref":"#/definitions/NfeSefazPISST"},"COFINS":{"$ref":"#/definitions/NfeSefazCOFINS"},"COFINSST":{"$ref":"#/definitions/NfeSefazCOFINSST"},"ICMSUFDest":{"$ref":"#/definitions/NfeSefazICMSUFDest"},"IS":{"$ref":"#/definitions/NfeSefazIS"},"IBSCBS":{"$ref":"#/definitions/NfeSefazTribNFe"}}},"NfeSefazICMS":{"type":"object","description":"Dados do ICMS Normal e ST.","properties":{"ICMS00":{"$ref":"#/definitions/NfeSefazICMS00"},"ICMS02":{"$ref":"#/definitions/NfeSefazICMS02"},"ICMS10":{"$ref":"#/definitions/NfeSefazICMS10"},"ICMS15":{"$ref":"#/definitions/NfeSefazICMS15"},"ICMS20":{"$ref":"#/definitions/NfeSefazICMS20"},"ICMS30":{"$ref":"#/definitions/NfeSefazICMS30"},"ICMS40":{"$ref":"#/definitions/NfeSefazICMS40"},"ICMS51":{"$ref":"#/definitions/NfeSefazICMS51"},"ICMS53":{"$ref":"#/definitions/NfeSefazICMS53"},"ICMS60":{"$ref":"#/definitions/NfeSefazICMS60"},"ICMS61":{"$ref":"#/definitions/NfeSefazICMS61"},"ICMS70":{"$ref":"#/definitions/NfeSefazICMS70"},"ICMS90":{"$ref":"#/definitions/NfeSefazICMS90"},"ICMSPart":{"$ref":"#/definitions/NfeSefazICMSPart"},"ICMSST":{"$ref":"#/definitions/NfeSefazICMSST"},"ICMSSN101":{"$ref":"#/definitions/NfeSefazICMSSN101"},"ICMSSN102":{"$ref":"#/definitions/NfeSefazICMSSN102"},"ICMSSN201":{"$ref":"#/definitions/NfeSefazICMSSN201"},"ICMSSN202":{"$ref":"#/definitions/NfeSefazICMSSN202"},"ICMSSN500":{"$ref":"#/definitions/NfeSefazICMSSN500"},"ICMSSN900":{"$ref":"#/definitions/NfeSefazICMSSN900"}}},"NfeSefazICMS00":{"type":"object","description":"Tributação pelo ICMS\r\n* 00 - Tributada integralmente","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 00 - Tributada integralmente","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true}},"required":["vICMS","pICMS","vBC","modBC","CST","orig"]},"NfeSefazICMS02":{"type":"object","description":"Tributação monofásica própria sobre combustíveis.","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 02 - Tributação monofásica própria sobre combustíveis","x-nullable":true},"qBCMono":{"type":"number","description":"Quantidade tributada.","minimum":0,"x-nullable":true},"adRemICMS":{"type":"number","description":"Alíquota ad rem do imposto.","minimum":0,"x-nullable":true},"vICMSMono":{"type":"number","description":"Valor do ICMS própri.","minimum":0,"x-nullable":true}},"required":["vICMSMono","adRemICMS","CST","orig"]},"NfeSefazICMS10":{"type":"object","description":"Tributação pelo ICMS\r\n* 10 - Tributada e com cobrança do ICMS por substituição tributária","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"* 10 - Tributada e com cobrança do ICMS por substituição tributária","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vBCFCP":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST.","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST.","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST.","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST.","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST.","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP retido por substituicao tributaria.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vICMSSTDeson":{"type":"number","description":"Valor do ICMS-ST desonerado.","minimum":0,"x-nullable":true},"motDesICMSST":{"type":"integer","description":"Motivo da desoneração do ICMS-ST: 3-Uso na agropecuária\r\n* 9 - Outros\r\n* 12 - Fomento agropecuário","x-nullable":true}},"required":["vICMSST","pICMSST","vBCST","modBCST","vICMS","pICMS","vBC","modBC","CST","orig"]},"NfeSefazICMS15":{"type":"object","description":"Tributação monofásica própria e com responsabilidade pela retenção sobre combustíveis.","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 15 - Tributação monofásica própria e com responsabilidade pela retenção sobre combustíveis","x-nullable":true},"qBCMono":{"type":"number","description":"Quantidade tributada.","minimum":0,"x-nullable":true},"adRemICMS":{"type":"number","description":"Alíquota ad rem do imposto.","minimum":0,"x-nullable":true},"vICMSMono":{"type":"number","description":"Valor do ICMS próprio.","minimum":0,"x-nullable":true},"qBCMonoReten":{"type":"number","description":"Quantidade tributada sujeita a retenção.","minimum":0,"x-nullable":true},"adRemICMSReten":{"type":"number","description":"Alíquota ad rem do imposto com retenção.","minimum":0,"x-nullable":true},"vICMSMonoReten":{"type":"number","description":"Valor do ICMS com retenção.","minimum":0,"x-nullable":true},"pRedAdRem":{"type":"number","description":"Percentual de redução do valor da alíquota ad rem do ICMS.","maximum":100,"minimum":0,"x-nullable":true},"motRedAdRem":{"type":"integer","description":"Motivo da redução do adrem\r\n* 1 - Transporte coletivo de passageiros\r\n* 9 - Outros","x-nullable":true}},"required":["vICMSMonoReten","adRemICMSReten","vICMSMono","adRemICMS","CST","orig"]},"NfeSefazICMS20":{"type":"object","description":"Tributção pelo ICMS\r\n* 20 - Com redução de base de cálculo","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 20 - Com redução de base de cálculo","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vBCFCP":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"motDesICMS":{"type":"integer","description":"Motivo da desoneração do ICMS:3-Uso na agropecuária\r\n* 9 - Outros\r\n* 12 - Fomento agropecuário","x-nullable":true},"indDeduzDeson":{"type":"integer","description":"Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd):\r\n* 0 - Valor do ICMS desonerado (vICMSDeson) não deduz do valor do item (vProd) / total da NF-e\r\n* 1 - Valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd) / total da NF-e","x-nullable":true}},"required":["vICMS","pICMS","vBC","pRedBC","modBC","CST","orig"]},"NfeSefazICMS30":{"type":"object","description":"Tributação pelo ICMS\r\n* 30 - Isenta ou não tributada e com cobrança do ICMS por substituição tributária","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 30 - Isenta ou não tributada e com cobrança do ICMS por substituição tributária","x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST.","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST.","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST.","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST.","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST.","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"motDesICMS":{"type":"integer","description":"Motivo da desoneração do ICMS:6-Utilitários Motocicleta AÁrea Livre\r\n* 7 - SUFRAMA\r\n* 9 - Outros","x-nullable":true},"indDeduzDeson":{"type":"integer","description":"Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd):\r\n* 0 - Valor do ICMS desonerado (vICMSDeson) não deduz do valor do item (vProd) / total da NF-e\r\n* 1 - Valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd) / total da NF-e","x-nullable":true}},"required":["vICMSST","pICMSST","vBCST","modBCST","CST","orig"]},"NfeSefazICMS40":{"type":"object","description":"Tributação pelo ICMS\r\n* 40 - Isenta\r\n* 41 - Não tributada\r\n* 50 - Suspensão","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributação pelo ICMS\r\n* 40 - Isenta\r\n* 41 - Não tributada\r\n* 50 - Suspensão\r\n* 51 - Diferimento","x-nullable":true},"vICMSDeson":{"type":"number","description":"O valor do ICMS será informado apenas nas operações com veículos beneficiados com a desoneração condicional do ICMS.","minimum":0,"x-nullable":true},"motDesICMS":{"type":"integer","description":"Este campo será preenchido quando o campo anterior estiver preenchido.\r\nInformar o motivo da desoneração:\r\n* 1 - Táxi\r\n* 3 - Produtor Agropecuário\r\n* 4 - Frotista/Locadora\r\n* 5 - Diplomático/Consular\r\n* 6 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 - CONTRAN e suas alterações)\r\n* 7 - SUFRAMA\r\n* 8 - Venda a órgão Público\r\n* 9 - Outros\r\n* 10 - Deficiente Condutor\r\n* 11 - Deficiente não condutor\r\n* 16 - Olimpíadas Rio 2016\r\n* 90 - Solicitado pelo Fisco","x-nullable":true},"indDeduzDeson":{"type":"integer","description":"Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd):\r\n* 0 - Valor do ICMS desonerado (vICMSDeson) não deduz do valor do item (vProd) / total da NF-e\r\n* 1 - Valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd) / total da NF-e","x-nullable":true}},"required":["CST","orig"]},"NfeSefazICMS51":{"type":"object","description":"Tributção pelo ICMS 51 - Diferimento. A exigência do preenchimento das informações do ICMS diferido fica à critério de cada UF.","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributação pelo ICMS 51 - Tributação com Diferimento.","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"x-nullable":true},"cBenefRBC":{"type":"string","description":"Código de Benefício Fiscal na UF aplicado ao item quando houver RBC.","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do imposto.","minimum":0,"x-nullable":true},"vICMSOp":{"type":"number","description":"Valor do ICMS da Operação.","minimum":0,"x-nullable":true},"pDif":{"type":"number","description":"Percentual do diferemento.","maximum":100,"minimum":0,"x-nullable":true},"vICMSDif":{"type":"number","description":"Valor do ICMS da diferido.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vBCFCP":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"pFCPDif":{"type":"number","description":"Percentual do diferimento do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCPDif":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) diferido.","minimum":0,"x-nullable":true},"vFCPEfet":{"type":"number","description":"Valor efetivo do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true}},"required":["CST","orig"]},"NfeSefazICMS53":{"type":"object","description":"Tributação monofásica sobre combustíveis com recolhimento diferido.","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 53 - Tributação monofásica sobre combustíveis com recolhimento diferido","x-nullable":true},"qBCMono":{"type":"number","description":"Quantidade tributada.","minimum":0,"x-nullable":true},"adRemICMS":{"type":"number","description":"Alíquota ad rem do imposto.","minimum":0,"x-nullable":true},"vICMSMonoOp":{"type":"number","description":"Valor do ICMS da operação.","minimum":0,"x-nullable":true},"pDif":{"type":"number","description":"Percentual do diferemento.","maximum":100,"minimum":0,"x-nullable":true},"vICMSMonoDif":{"type":"number","description":"Valor do ICMS diferido.","minimum":0,"x-nullable":true},"vICMSMono":{"type":"number","description":"Valor do ICMS próprio devido.","minimum":0,"x-nullable":true},"qBCMonoDif":{"type":"number","description":"Quantidade tributada diferida.\r\nOBS: Campo revogado pela NT2023.001v1.20","minimum":0,"x-nullable":true},"adRemICMSDif":{"type":"number","description":"Alíquota ad rem do imposto diferido.\r\nOBS: Campo revogado pela NT2023.001v1.20","minimum":0,"x-nullable":true}},"required":["CST","orig"]},"NfeSefazICMS60":{"type":"object","description":"Tributação pelo ICMS\r\n* 60 - ICMS cobrado anteriormente por substituição tributária","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributação pelo ICMS\r\n* 60 - ICMS cobrado anteriormente por substituição tributária","x-nullable":true},"vBCSTRet":{"type":"number","description":"Valor da BC do ICMS ST retido anteriormente.","minimum":0,"x-nullable":true},"pST":{"type":"number","description":"Aliquota suportada pelo consumidor final.","minimum":0,"x-nullable":true},"vICMSSubstituto":{"type":"number","description":"Valor do ICMS Próprio do Substituto cobrado em operação anterior.","minimum":0,"x-nullable":true},"vICMSSTRet":{"type":"number","description":"Valor do ICMS ST retido anteriormente.","minimum":0,"x-nullable":true},"vBCFCPSTRet":{"type":"number","description":"Valor da Base de cálculo do FCP retido anteriormente por ST.","minimum":0,"x-nullable":true},"pFCPSTRet":{"type":"number","description":"Percentual de FCP retido anteriormente por substituição tributária.","minimum":0,"x-nullable":true},"vFCPSTRet":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"pRedBCEfet":{"type":"number","description":"Percentual de redução da base de cálculo efetiva.","minimum":0,"x-nullable":true},"vBCEfet":{"type":"number","description":"Valor da base de cálculo efetiva.","minimum":0,"x-nullable":true},"pICMSEfet":{"type":"number","description":"Alíquota do ICMS efetiva.","minimum":0,"x-nullable":true},"vICMSEfet":{"type":"number","description":"Valor do ICMS efetivo.","minimum":0,"x-nullable":true}},"required":["CST","orig"]},"NfeSefazICMS61":{"type":"object","description":"Tributação monofásica sobre combustíveis cobrada anteriormente.","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 61 - Tributação monofásica sobre combustíveis cobrada anteriormente","x-nullable":true},"qBCMonoRet":{"type":"number","description":"Quantidade tributada retida anteriormente.","minimum":0,"x-nullable":true},"adRemICMSRet":{"type":"number","description":"Alíquota ad rem do imposto retido anteriormente.","minimum":0,"x-nullable":true},"vICMSMonoRet":{"type":"number","description":"Valor do ICMS retido anteriormente.","minimum":0,"x-nullable":true}},"required":["vICMSMonoRet","adRemICMSRet","CST","orig"]},"NfeSefazICMS70":{"type":"object","description":"Tributação pelo ICMS\r\n* 70 - Com redução de base de cálculo e cobrança do ICMS por substituição tributária","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 70 - Com redução de base de cálculo e cobrança do ICMS por substituição tributária","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vBCFCP":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST.","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST.","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST.","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST.","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST.","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"motDesICMS":{"type":"integer","description":"Motivo da desoneração do ICMS:3-Uso na agropecuária\r\n* 9 - Outros\r\n* 12 - Fomento agropecuário","x-nullable":true},"indDeduzDeson":{"type":"integer","description":"Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd):\r\n* 0 - Valor do ICMS desonerado (vICMSDeson) não deduz do valor do item (vProd) / total da NF-e\r\n* 1 - Valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd) / total da NF-e","x-nullable":true},"vICMSSTDeson":{"type":"number","description":"Valor do ICMS-ST desonerado.","minimum":0,"x-nullable":true},"motDesICMSST":{"type":"integer","description":"Motivo da desoneração do ICMS-ST: 3-Uso na agropecuária\r\n* 9 - Outros\r\n* 12 - Fomento agropecuário","x-nullable":true}},"required":["vICMSST","pICMSST","vBCST","modBCST","vICMS","pICMS","vBC","pRedBC","modBC","CST","orig"]},"NfeSefazICMS90":{"type":"object","description":"Tributação pelo ICMS\r\n* 90 - Outras","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 90 - Outras","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"vBCFCP":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCP":{"type":"number","description":"Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).","minimum":0,"x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST.","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST.","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST.","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST.","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST.","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor do ICMS de desoneração.","minimum":0,"x-nullable":true},"motDesICMS":{"type":"integer","description":"Motivo da desoneração do ICMS:3-Uso na agropecuária\r\n* 9 - Outros\r\n* 12 - Fomento agropecuário","x-nullable":true},"indDeduzDeson":{"type":"integer","description":"Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd):\r\n* 0 - Valor do ICMS desonerado (vICMSDeson) não deduz do valor do item (vProd) / total da NF-e\r\n* 1 - Valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd) / total da NF-e","x-nullable":true},"vICMSSTDeson":{"type":"number","description":"Valor do ICMS-ST desonerado.","minimum":0,"x-nullable":true},"motDesICMSST":{"type":"integer","description":"Motivo da desoneração do ICMS-ST: 3-Uso na agropecuária\r\n* 9 - Outros\r\n* 12 - Fomento agropecuário","x-nullable":true}},"required":["CST","orig"]},"NfeSefazICMSPart":{"type":"object","description":"Partilha do ICMS entre a UF de origem e UF de destino ou a UF definida na legislação\r\nOperação interestadual para consumidor final com partilha do ICMS  devido na operação entre a UF de origem e a UF do destinatário ou ou a UF definida na legislação. (Ex. UF da concessionária de entrega do  veículos).","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributação pelo ICMS\r\n* 10 - Tributada e com cobrança do ICMS por substituição tributária\r\n* 90 - Outros","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST.","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST.","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST.","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST.","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST.","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP retido por substituicao tributaria.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"pBCOp":{"type":"number","description":"Percentual para determinação do valor  da Base de Cálculo da operação própria.","minimum":0,"x-nullable":true},"UFST":{"type":"string","description":"Sigla da UF para qual é devido o ICMS ST da operação.","x-nullable":true}},"required":["UFST","pBCOp","vICMSST","pICMSST","vBCST","modBCST","vICMS","pICMS","vBC","modBC","CST","orig"]},"NfeSefazICMSST":{"type":"object","description":"Grupo de informação do ICMSST devido para a UF de destino, nas operações interestaduais de produtos que tiveram retenção antecipada de ICMS por ST na UF do remetente. Repasse via Substituto Tributário.","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CST":{"type":"string","description":"Tributção pelo ICMS\r\n* 41 - Não Tributado\r\n* 60 - Cobrado anteriormente por substituição tributária","x-nullable":true},"vBCSTRet":{"type":"number","description":"Informar o valor da BC do ICMS ST retido na UF remetente.","minimum":0,"x-nullable":true},"pST":{"type":"number","description":"Aliquota suportada pelo consumidor final.","minimum":0,"x-nullable":true},"vICMSSubstituto":{"type":"number","description":"Valor do ICMS Próprio do Substituto cobrado em operação anterior.","minimum":0,"x-nullable":true},"vICMSSTRet":{"type":"number","description":"Informar o valor do ICMS ST retido na UF remetente (iv2.0)).","minimum":0,"x-nullable":true},"vBCFCPSTRet":{"type":"number","description":"Informar o valor da Base de Cálculo do FCP retido anteriormente por ST.","minimum":0,"x-nullable":true},"pFCPSTRet":{"type":"number","description":"Percentual relativo ao Fundo de Combate à Pobreza (FCP) retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPSTRet":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) retido por substituição tributária.","minimum":0,"x-nullable":true},"vBCSTDest":{"type":"number","description":"Informar o valor da BC do ICMS ST da UF destino.","minimum":0,"x-nullable":true},"vICMSSTDest":{"type":"number","description":"Informar o valor da BC do ICMS ST da UF destino (v2.0).","minimum":0,"x-nullable":true},"pRedBCEfet":{"type":"number","description":"Percentual de redução da base de cálculo efetiva.","minimum":0,"x-nullable":true},"vBCEfet":{"type":"number","description":"Valor da base de cálculo efetiva.","minimum":0,"x-nullable":true},"pICMSEfet":{"type":"number","description":"Alíquota do ICMS efetivo.","minimum":0,"x-nullable":true},"vICMSEfet":{"type":"number","description":"Valor do ICMS efetivo.","minimum":0,"x-nullable":true}},"required":["vICMSSTDest","vBCSTDest","vICMSSTRet","vBCSTRet","CST","orig"]},"NfeSefazICMSSN101":{"type":"object","description":"Tributação do ICMS pelo SIMPLES NACIONAL e CSOSN=101 (v.2.0).","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CSOSN":{"type":"string","description":"* 101 - Tributada pelo Simples Nacional com permissão de crédito. (v.2.0)","x-nullable":true},"pCredSN":{"type":"number","description":"Alíquota aplicável de cálculo do crédito (Simples Nacional). (v2.0).","minimum":0,"x-nullable":true},"vCredICMSSN":{"type":"number","description":"Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) (v2.0).","minimum":0,"x-nullable":true}},"required":["vCredICMSSN","pCredSN","CSOSN","orig"]},"NfeSefazICMSSN102":{"type":"object","description":"Tributação do ICMS pelo SIMPLES NACIONAL e CSOSN=102, 103, 300 ou 400 (v.2.0)).","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CSOSN":{"type":"string","description":"* 102 - Tributada pelo Simples Nacional sem permissão de crédito\r\n* 103 - Isenção do ICMS  no Simples Nacional para faixa de receita bruta\r\n* 300 - Imune\r\n* 400 - Não tributda pelo Simples Nacional (v.2.0) (v.2.0)","x-nullable":true}},"required":["CSOSN","orig"]},"NfeSefazICMSSN201":{"type":"object","description":"Tributação do ICMS pelo SIMPLES NACIONAL e CSOSN=201 (v.2.0).","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CSOSN":{"type":"string","description":"* 201 - Tributada pelo Simples Nacional com permissão de crédito e com cobrança do ICMS por Substituição Tributária (v.2.0)","x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor). (v2.0)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST (v2.0).","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST  (v2.0).","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST (v2.0).","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST (v2.0).","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST (v2.0).","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"pCredSN":{"type":"number","description":"Alíquota aplicável de cálculo do crédito (Simples Nacional). (v2.0).","minimum":0,"x-nullable":true},"vCredICMSSN":{"type":"number","description":"Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) (v2.0).","minimum":0,"x-nullable":true}},"required":["vCredICMSSN","pCredSN","vICMSST","pICMSST","vBCST","modBCST","CSOSN","orig"]},"NfeSefazICMSSN202":{"type":"object","description":"Tributação do ICMS pelo SIMPLES NACIONAL e CSOSN=202 ou 203 (v.2.0).","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CSOSN":{"type":"string","description":"* 202 - Tributada pelo Simples Nacional sem permissão de crédito e com cobrança do ICMS por Substituição Tributária\r\n* 203 - Isenção do ICMS nos Simples Nacional para faixa de receita bruta e com cobrança do ICMS por Substituição Tributária (v.2.0)","x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor). (v2.0)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST (v2.0).","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST  (v2.0).","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST (v2.0).","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST (v2.0).","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST (v2.0).","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true}},"required":["vICMSST","pICMSST","vBCST","modBCST","CSOSN","orig"]},"NfeSefazICMSSN500":{"type":"object","description":"Tributação do ICMS pelo SIMPLES NACIONAL,CRT=1 - Simples Nacional e CSOSN=500 (v.2.0).","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CSOSN":{"type":"string","description":"* 500 - ICMS cobrado anterirmente por substituição tributária (substituído) ou por antecipação\r\n(v.2.0).","x-nullable":true},"vBCSTRet":{"type":"number","description":"Valor da BC do ICMS ST retido anteriormente (v2.0).","minimum":0,"x-nullable":true},"pST":{"type":"number","description":"Aliquota suportada pelo consumidor final.","minimum":0,"x-nullable":true},"vICMSSubstituto":{"type":"number","description":"Valor do ICMS próprio do substituto.","minimum":0,"x-nullable":true},"vICMSSTRet":{"type":"number","description":"Valor do ICMS ST retido anteriormente  (v2.0).","minimum":0,"x-nullable":true},"vBCFCPSTRet":{"type":"number","description":"Valor da Base de cálculo do FCP retido anteriormente.","minimum":0,"x-nullable":true},"pFCPSTRet":{"type":"number","description":"Percentual de FCP retido anteriormente por substituição tributária.","minimum":0,"x-nullable":true},"vFCPSTRet":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"pRedBCEfet":{"type":"number","description":"Percentual de redução da base de cálculo efetiva.","minimum":0,"x-nullable":true},"vBCEfet":{"type":"number","description":"Valor da base de cálculo efetiva.","minimum":0,"x-nullable":true},"pICMSEfet":{"type":"number","description":"Alíquota do ICMS efetiva.","minimum":0,"x-nullable":true},"vICMSEfet":{"type":"number","description":"Valor do ICMS efetivo.","minimum":0,"x-nullable":true}},"required":["CSOSN","orig"]},"NfeSefazICMSSN900":{"type":"object","description":"Tributação do ICMS pelo SIMPLES NACIONAL, CRT=1 - Simples Nacional, CRT=4 - MEI e CSOSN=900 (v2.0).","properties":{"orig":{"type":"integer","description":"Origem da mercadoria:\r\n* 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8;\r\n* 1 - Estrangeira - Importação direta, exceto a indicada no código 6;\r\n* 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7;\r\n* 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%;\r\n* 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes;\r\n* 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%;\r\n* 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural;\r\n* 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural;\r\n* 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.","x-nullable":true},"CSOSN":{"type":"string","description":"Tributação pelo ICMS 900 - Outros(v2.0).","x-nullable":true},"modBC":{"type":"integer","description":"Modalidade de determinação da BC do ICMS:\r\n* 0 - Margem Valor Agregado (%%)\r\n* 1 - Pauta (valor)\r\n* 2 - Preço Tabelado Máximo (valor)\r\n* 3 - Valor da Operação","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do ICMS.","minimum":0,"x-nullable":true},"pRedBC":{"type":"number","description":"Percentual de redução da BC.","minimum":0,"x-nullable":true},"pICMS":{"type":"number","description":"Alíquota do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor do ICMS.","minimum":0,"x-nullable":true},"modBCST":{"type":"integer","description":"Modalidade de determinação da BC do ICMS ST:\r\n* 0 - Preço tabelado ou máximo  sugerido\r\n* 1 - Lista Negativa (valor)\r\n* 2 - Lista Positiva (valor)\r\n* 3 - Lista Neutra (valor)\r\n* 4 - Margem Valor Agregado (%%)\r\n* 5 - Pauta (valor)\r\n* 6 - Valor da Operação","x-nullable":true},"pMVAST":{"type":"number","description":"Percentual da Margem de Valor Adicionado ICMS ST.","minimum":0,"x-nullable":true},"pRedBCST":{"type":"number","description":"Percentual de redução da BC ICMS ST.","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"Valor da BC do ICMS ST.","minimum":0,"x-nullable":true},"pICMSST":{"type":"number","description":"Alíquota do ICMS ST.","minimum":0,"x-nullable":true},"vICMSST":{"type":"number","description":"Valor do ICMS ST.","minimum":0,"x-nullable":true},"vBCFCPST":{"type":"number","description":"Valor da Base de cálculo do FCP.","minimum":0,"x-nullable":true},"pFCPST":{"type":"number","description":"Percentual de FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor do FCP retido por substituição tributária.","minimum":0,"x-nullable":true},"pCredSN":{"type":"number","description":"Alíquota aplicável de cálculo do crédito (Simples Nacional). (v2.0).","minimum":0,"x-nullable":true},"vCredICMSSN":{"type":"number","description":"Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) (v2.0).","minimum":0,"x-nullable":true}},"required":["CSOSN","orig"]},"NfeSefazIpi":{"type":"object","properties":{"CNPJProd":{"type":"string","description":"CNPJ do produtor da mercadoria, quando diferente do emitente. Somente para os casos de exportação direta ou indireta.","maxLength":14,"x-nullable":true},"cSelo":{"type":"string","description":"Código do selo de controle do IPI.","maxLength":60,"minLength":1,"x-nullable":true},"qSelo":{"type":"integer","format":"int64","description":"Quantidade de selo de controle do IPI.","x-nullable":true},"cEnq":{"type":"string","description":"Código de Enquadramento Legal do IPI (tabela a ser criada pela RFB).","maxLength":3,"minLength":1,"x-nullable":true},"IPITrib":{"$ref":"#/definitions/NfeSefazIPITrib"},"IPINT":{"$ref":"#/definitions/NfeSefazIPINT"}},"required":["cEnq"]},"NfeSefazIPITrib":{"type":"object","properties":{"CST":{"type":"string","description":"Código da Situação Tributária do IPI:\r\n* 00 - Entrada com recuperação de crédito\r\n* 49 - Outras entradas\r\n* 50 - Saída tributada\r\n* 99 - Outras saídas","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do IPI.","minimum":0,"x-nullable":true},"pIPI":{"type":"number","description":"Alíquota do IPI.","minimum":0,"x-nullable":true},"qUnid":{"type":"number","description":"Quantidade total na unidade padrão para tributação.","minimum":0,"x-nullable":true},"vUnid":{"type":"number","description":"Valor por Unidade Tributável. Informar o valor do imposto Pauta por unidade de medida.","minimum":0,"x-nullable":true},"vIPI":{"type":"number","description":"Valor do IPI.","minimum":0,"x-nullable":true}},"required":["vIPI","CST"]},"NfeSefazIPINT":{"type":"object","properties":{"CST":{"type":"string","description":"Código da Situação Tributária do IPI:\r\n* 01 - Entrada tributada com alíquota zero\r\n* 02 - Entrada isenta\r\n* 03 - Entrada não-tributada\r\n* 04 - Entrada imune\r\n* 05 - Entrada com suspensão\r\n* 51 - Saída tributada com alíquota zero\r\n* 52 - Saída isenta\r\n* 53 - Saída não-tributada\r\n* 54 - Saída imune\r\n* 55 - Saída com suspensão","x-nullable":true}},"required":["CST"]},"NfeSefazII":{"type":"object","description":"Dados do Imposto de Importação.","properties":{"vBC":{"type":"number","description":"Base da BC do Imposto de Importação.","minimum":0,"x-nullable":true},"vDespAdu":{"type":"number","description":"Valor das despesas aduaneiras.","minimum":0,"x-nullable":true},"vII":{"type":"number","description":"Valor do Imposto de Importação.","minimum":0,"x-nullable":true},"vIOF":{"type":"number","description":"Valor do Imposto sobre Operações Financeiras.","minimum":0,"x-nullable":true}},"required":["vIOF","vII","vDespAdu","vBC"]},"NfeSefazISSQN":{"type":"object","description":"ISSQN.","properties":{"vBC":{"type":"number","description":"Valor da BC do ISSQN.","minimum":0,"x-nullable":true},"vAliq":{"type":"number","description":"Alíquota do ISSQN.","minimum":0,"x-nullable":true},"vISSQN":{"type":"number","description":"Valor da do ISSQN.","minimum":0,"x-nullable":true},"cMunFG":{"type":"string","description":"Informar o município de ocorrência do fato gerador do ISSQN. Utilizar a Tabela do IBGE (Anexo VII - Tabela de UF, Município e País). “Atenção, não vincular com os campos B12, C10 ou E10” v2.0.","x-nullable":true},"cListServ":{"type":"string","description":"Informar o Item da lista de serviços da LC 116/03 em que se classifica o serviço.","x-nullable":true},"vDeducao":{"type":"number","description":"Valor dedução para redução da base de cálculo.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vOutro":{"type":"number","description":"Valor outras retenções.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDescIncond":{"type":"number","description":"Valor desconto incondicionado.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDescCond":{"type":"number","description":"Valor desconto condicionado.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vISSRet":{"type":"number","description":"Valor Retenção ISS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"indISS":{"type":"integer","description":"Exibilidade do ISS:1-Exigível\r\n* 2 - Não incidente\r\n* 3 - Isenção\r\n* 4 - Exportação\r\n* 5 - Imunidade\r\n* 6 - Exig.Susp. Judicial\r\n* 7 - Exig.Susp. ADM","x-nullable":true},"cServico":{"type":"string","description":"Código do serviço prestado dentro do município.","maxLength":20,"minLength":1,"x-nullable":true},"cMun":{"type":"string","description":"Código do Município de Incidência do Imposto.","x-nullable":true},"cPais":{"type":"string","description":"Código de Pais.","x-nullable":true},"nProcesso":{"type":"string","description":"Número do Processo administrativo ou judicial de suspenção do processo.","maxLength":30,"minLength":1,"x-nullable":true},"indIncentivo":{"type":"integer","description":"Indicador de Incentivo Fiscal. 1=Sim\r\n* 2 - Não","x-nullable":true}},"required":["indIncentivo","indISS","cListServ","cMunFG","vISSQN","vAliq","vBC"]},"NfeSefazPIS":{"type":"object","description":"Dados do PIS.","properties":{"PISAliq":{"$ref":"#/definitions/NfeSefazPISAliq"},"PISQtde":{"$ref":"#/definitions/NfeSefazPISQtde"},"PISNT":{"$ref":"#/definitions/NfeSefazPISNT"},"PISOutr":{"$ref":"#/definitions/NfeSefazPISOutr"}}},"NfeSefazPISAliq":{"type":"object","description":"Código de Situação Tributária do PIS.\r\n* 01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não Cumulativo)\r\n* 02 - Operação Tributável - Base de Calculo = Valor da Operação (Alíquota Diferenciada)","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do PIS.\r\n* 01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não Cumulativo)\r\n* 02 - Operação Tributável - Base de Calculo = Valor da Operação (Alíquota Diferenciada)","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do PIS.","minimum":0,"x-nullable":true},"pPIS":{"type":"number","description":"Alíquota do PIS (em percentual).","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true}},"required":["vPIS","pPIS","vBC","CST"]},"NfeSefazPISQtde":{"type":"object","description":"Código de Situação Tributária do PIS.\r\n* 03 - Operação Tributável - Base de Calculo = Quantidade Vendida x Alíquota por Unidade de Produto","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do PIS.\r\n* 03 - Operação Tributável - Base de Calculo = Quantidade Vendida x Alíquota por Unidade de Produto","x-nullable":true},"qBCProd":{"type":"number","description":"Quantidade Vendida  (NT2011/004).","minimum":0,"x-nullable":true},"vAliqProd":{"type":"number","description":"Alíquota do PIS (em reais) (NT2011/004).","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true}},"required":["vPIS","vAliqProd","qBCProd","CST"]},"NfeSefazPISNT":{"type":"object","description":"Código de Situação Tributária do PIS.\r\n* 04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)\r\n* 06 - Operação Tributável - Alíquota Zero\r\n* 07 - Operação Isenta da contribuição\r\n* 08 - Operação Sem Incidência da contribuição\r\n* 09 - Operação com suspensão da contribuição","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do PIS.\r\n* 04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)\r\n* 05 - Operação Tributável (ST)\r\n* 06 - Operação Tributável - Alíquota Zero\r\n* 07 - Operação Isenta da contribuição\r\n* 08 - Operação Sem Incidência da contribuição\r\n* 09 - Operação com suspensão da contribuição","x-nullable":true}},"required":["CST"]},"NfeSefazPISOutr":{"type":"object","description":"Código de Situação Tributária do PIS.\r\n* 99 - Outras Operações","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do PIS.\r\n* 99 - Outras Operações","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do PIS.","minimum":0,"x-nullable":true},"pPIS":{"type":"number","description":"Alíquota do PIS (em percentual).","minimum":0,"x-nullable":true},"qBCProd":{"type":"number","description":"Quantidade Vendida (NT2011/004).","minimum":0,"x-nullable":true},"vAliqProd":{"type":"number","description":"Alíquota do PIS (em reais) (NT2011/004).","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true}},"required":["vPIS","CST"]},"NfeSefazPISST":{"type":"object","description":"Dados do PIS Substituição Tributária.","properties":{"vBC":{"type":"number","description":"Valor da BC do PIS ST.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"pPIS":{"type":"number","description":"Alíquota do PIS ST (em percentual).","minimum":0,"x-nullable":true},"qBCProd":{"type":"number","description":"Quantidade Vendida.","minimum":0,"x-nullable":true},"vAliqProd":{"type":"number","description":"Alíquota do PIS ST (em reais).","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS ST.","minimum":0,"x-nullable":true},"indSomaPISST":{"type":"integer","description":"Indica se o valor do PISST compõe o valor total da NF-e.","x-nullable":true}},"required":["vPIS"]},"NfeSefazCOFINS":{"type":"object","description":"Dados do COFINS.","properties":{"COFINSAliq":{"$ref":"#/definitions/NfeSefazCOFINSAliq"},"COFINSQtde":{"$ref":"#/definitions/NfeSefazCOFINSQtde"},"COFINSNT":{"$ref":"#/definitions/NfeSefazCOFINSNT"},"COFINSOutr":{"$ref":"#/definitions/NfeSefazCOFINSOutr"}}},"NfeSefazCOFINSAliq":{"type":"object","description":"Código de Situação Tributária do COFINS.\r\n* 01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não Cumulativo)\r\n* 02 - Operação Tributável - Base de Calculo = Valor da Operação (Alíquota Diferenciada)","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do COFINS.\r\n* 01 - Operação Tributável - Base de Cálculo = Valor da Operação Alíquota Normal (Cumulativo/Não Cumulativo)\r\n* 02 - Operação Tributável - Base de Calculo = Valor da Operação (Alíquota Diferenciada)","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do COFINS.","minimum":0,"x-nullable":true},"pCOFINS":{"type":"number","description":"Alíquota do COFINS (em percentual).","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS.","minimum":0,"x-nullable":true}},"required":["vCOFINS","pCOFINS","vBC","CST"]},"NfeSefazCOFINSQtde":{"type":"object","description":"Código de Situação Tributária do COFINS.\r\n* 03 - Operação Tributável - Base de Calculo = Quantidade Vendida x Alíquota por Unidade de Produto","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do COFINS.\r\n* 03 - Operação Tributável - Base de Calculo = Quantidade Vendida x Alíquota por Unidade de Produto","x-nullable":true},"qBCProd":{"type":"number","description":"Quantidade Vendida (NT2011/004).","minimum":0,"x-nullable":true},"vAliqProd":{"type":"number","description":"Alíquota do COFINS (em reais) (NT2011/004).","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS.","minimum":0,"x-nullable":true}},"required":["vCOFINS","vAliqProd","qBCProd","CST"]},"NfeSefazCOFINSNT":{"type":"object","description":"Código de Situação Tributária do COFINS:\r\n* 04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)\r\n* 06 - Operação Tributável - Alíquota Zero\r\n* 07 - Operação Isenta da contribuição\r\n* 08 - Operação Sem Incidência da contribuição\r\n* 09 - Operação com suspensão da contribuição","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do COFINS:\r\n* 04 - Operação Tributável - Tributação Monofásica - (Alíquota Zero)\r\n* 05 - Operação Tributável (ST)\r\n* 06 - Operação Tributável - Alíquota Zero\r\n* 07 - Operação Isenta da contribuição\r\n* 08 - Operação Sem Incidência da contribuição\r\n* 09 - Operação com suspensão da contribuição","x-nullable":true}},"required":["CST"]},"NfeSefazCOFINSOutr":{"type":"object","description":"Código de Situação Tributária do COFINS:\r\n* 49 - Outras Operações de Saída\r\n* 50 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Tributada no Mercado Interno\r\n* 51 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno\r\n* 52 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita de Exportação\r\n* 53 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno\r\n* 54 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas no Mercado Interno e de Exportação\r\n* 55 - Operação com Direito a Crédito - Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação\r\n* 56 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação\r\n* 60 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Tributada no Mercado Interno\r\n* 61 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Não-Tributada no Mercado Interno\r\n* 62 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita de Exportação\r\n* 63 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno\r\n* 64 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e de Exportação\r\n* 65 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação\r\n* 66 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação\r\n* 67 - Crédito Presumido - Outras Operações\r\n* 70 - Operação de Aquisição sem Direito a Crédito\r\n* 71 - Operação de Aquisição com Isenção\r\n* 72 - Operação de Aquisição com Suspensão\r\n* 73 - Operação de Aquisição a Alíquota Zero\r\n* 74 - Operação de Aquisição sem Incidência da Contribuição\r\n* 75 - Operação de Aquisição por Substituição Tributária\r\n* 98 - Outras Operações de Entrada\r\n* 99 - Outras Operações","properties":{"CST":{"type":"string","description":"Código de Situação Tributária do COFINS:\r\n* 49 - Outras Operações de Saída\r\n* 50 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Tributada no Mercado Interno\r\n* 51 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita Não Tributada no Mercado Interno\r\n* 52 - Operação com Direito a Crédito - Vinculada Exclusivamente a Receita de Exportação\r\n* 53 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno\r\n* 54 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas no Mercado Interno e de Exportação\r\n* 55 - Operação com Direito a Crédito - Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação\r\n* 56 - Operação com Direito a Crédito - Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação\r\n* 60 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Tributada no Mercado Interno\r\n* 61 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita Não-Tributada no Mercado Interno\r\n* 62 - Crédito Presumido - Operação de Aquisição Vinculada Exclusivamente a Receita de Exportação\r\n* 63 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno\r\n* 64 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas no Mercado Interno e de Exportação\r\n* 65 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Não-Tributadas no Mercado Interno e de Exportação\r\n* 66 - Crédito Presumido - Operação de Aquisição Vinculada a Receitas Tributadas e Não-Tributadas no Mercado Interno, e de Exportação\r\n* 67 - Crédito Presumido - Outras Operações\r\n* 70 - Operação de Aquisição sem Direito a Crédito\r\n* 71 - Operação de Aquisição com Isenção\r\n* 72 - Operação de Aquisição com Suspensão\r\n* 73 - Operação de Aquisição a Alíquota Zero\r\n* 74 - Operação de Aquisição sem Incidência da Contribuição\r\n* 75 - Operação de Aquisição por Substituição Tributária\r\n* 98 - Outras Operações de Entrada\r\n* 99 - Outras Operações","x-nullable":true},"vBC":{"type":"number","description":"Valor da BC do COFINS.","minimum":0,"x-nullable":true},"pCOFINS":{"type":"number","description":"Alíquota do COFINS (em percentual).","minimum":0,"x-nullable":true},"qBCProd":{"type":"number","description":"Quantidade Vendida (NT2011/004).","minimum":0,"x-nullable":true},"vAliqProd":{"type":"number","description":"Alíquota do COFINS (em reais) (NT2011/004).","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS.","minimum":0,"x-nullable":true}},"required":["vCOFINS","CST"]},"NfeSefazCOFINSST":{"type":"object","description":"Dados do COFINS da\r\nSubstituição Tributaria.","properties":{"vBC":{"type":"number","description":"Valor da BC do COFINS ST.","minimum":0,"x-nullable":true},"pCOFINS":{"type":"number","description":"Alíquota do COFINS ST(em percentual).","minimum":0,"x-nullable":true},"qBCProd":{"type":"number","description":"Quantidade Vendida.","minimum":0,"x-nullable":true},"vAliqProd":{"type":"number","description":"Alíquota do COFINS ST(em reais).","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS ST.","minimum":0,"x-nullable":true},"indSomaCOFINSST":{"type":"integer","description":"Indica se o valor da COFINS ST compõe o valor total da NFe.","x-nullable":true}},"required":["vCOFINS"]},"NfeSefazICMSUFDest":{"type":"object","description":"Grupo a ser informado nas vendas interestarduais para consumidor final, não contribuinte de ICMS.","properties":{"vBCUFDest":{"type":"number","description":"Valor da Base de Cálculo do ICMS na UF do destinatário.","minimum":0,"x-nullable":true},"vBCFCPUFDest":{"type":"number","description":"Valor da Base de Cálculo do FCP na UF do destinatário.","minimum":0,"x-nullable":true},"pFCPUFDest":{"type":"number","description":"Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF.","minimum":0,"x-nullable":true},"pICMSUFDest":{"type":"number","description":"Alíquota adotada nas operações internas na UF do destinatário para o produto / mercadoria.","minimum":0,"x-nullable":true},"pICMSInter":{"type":"number","description":"Alíquota interestadual das UF envolvidas:\r\n* 4%% alíquota interestadual para produtos importados\r\n* 7%% para os Estados de origem do Sul e Sudeste (exceto ES), destinado para os Estados do Norte e Nordeste  ou ES\r\n* 12%% para os demais casos.","minimum":0,"x-nullable":true},"pICMSInterPart":{"type":"number","description":"Percentual de partilha para a UF do destinatário:\r\n* 40%% em 2016\r\n* 60%% em 2017\r\n* 80%% em 2018\r\n* 100%% a partir de 2019.","minimum":0,"x-nullable":true},"vFCPUFDest":{"type":"number","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino.","minimum":0,"x-nullable":true},"vICMSUFDest":{"type":"number","description":"Valor do ICMS de partilha para a UF do destinatário.","minimum":0,"x-nullable":true},"vICMSUFRemet":{"type":"number","description":"Valor do ICMS de partilha para a UF do remetente. Nota: A partir de 2019, este valor será zero.","minimum":0,"x-nullable":true}},"required":["vICMSUFRemet","vICMSUFDest","pICMSInterPart","pICMSInter","pICMSUFDest","vBCUFDest"]},"NfeSefazIS":{"type":"object","description":"Grupo de informações do Imposto Seletivo.","properties":{"CSTIS":{"type":"string","description":"Código Situação Tributária do Imposto Seletivo.","x-nullable":true},"cClassTribIS":{"type":"string","x-nullable":true},"vBCIS":{"type":"number","description":"Valor do BC.","minimum":0,"x-nullable":true},"pIS":{"type":"number","description":"Alíquota do Imposto Seletivo (percentual).","minimum":0,"x-nullable":true},"pISEspec":{"type":"number","description":"Alíquota do Imposto Seletivo (por valor).","minimum":0,"x-nullable":true},"uTrib":{"type":"string","description":"Unidade de medida apropriada especificada em Lei Ordinaria para fins de apuração do Imposto Seletivo.","maxLength":6,"minLength":1,"x-nullable":true},"qTrib":{"type":"number","description":"Quantidade com abse no campo uTrib informado.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vIS":{"type":"number","description":"Valor do Imposto Seletivo calculado.","minimum":0,"x-nullable":true}},"required":["CSTIS"]},"NfeSefazTribNFe":{"type":"object","description":"Grupo de informações dos tributos IBS, CBS e Imposto Seletivo.","properties":{"CST":{"type":"string","description":"Código Situação Tributária do IBS/CBS.","x-nullable":true},"cClassTrib":{"type":"string","x-nullable":true},"indDoacao":{"type":"integer","description":"Indica se a operação é de doação.","x-nullable":true},"gIBSCBS":{"$ref":"#/definitions/NfeSefazCIBS"},"gIBSCBSMono":{"$ref":"#/definitions/NfeSefazMonofasia"},"gTransfCred":{"$ref":"#/definitions/NfeSefazTransfCred"},"gAjusteCompet":{"$ref":"#/definitions/NfeSefazAjusteCompet"},"gEstornoCred":{"$ref":"#/definitions/NfeSefazEstornoCred"},"gCredPresOper":{"$ref":"#/definitions/NfeSefazCredPresOper"},"gCredPresIBSZFM":{"$ref":"#/definitions/NfeSefazCredPresIBSZFM"}},"required":["CST"]},"NfeSefazCIBS":{"type":"object","properties":{"vBC":{"type":"number","description":"Valor do BC.","minimum":0,"x-nullable":true},"gIBSUF":{"$ref":"#/definitions/NfeSefazGIBSUF"},"gIBSMun":{"$ref":"#/definitions/NfeSefazGIBSMun"},"vIBS":{"type":"number","description":"Valor do IBS.","minimum":0,"x-nullable":true},"gCBS":{"$ref":"#/definitions/NfeSefazGCBS"},"gTribRegular":{"$ref":"#/definitions/NfeSefazTribRegular"},"gTribCompraGov":{"$ref":"#/definitions/NfeSefazTribCompraGov"}},"required":["gCBS","vIBS","gIBSMun","gIBSUF","vBC"]},"NfeSefazGIBSUF":{"type":"object","description":"Grupo de informações do IBS na UF.","properties":{"pIBSUF":{"type":"number","description":"Aliquota do IBS de competência das UF (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/NfeSefazDif"},"gDevTrib":{"$ref":"#/definitions/NfeSefazDevTrib"},"gRed":{"$ref":"#/definitions/NfeSefazRed"},"vIBSUF":{"type":"number","description":"Valor do IBS de competência das UF.","minimum":0,"x-nullable":true}},"required":["vIBSUF","pIBSUF"]},"NfeSefazDif":{"type":"object","description":"Grupo de campos do Diferimento.","properties":{"pDif":{"type":"number","description":"Percentual do diferimento.","minimum":0,"x-nullable":true},"vDif":{"type":"number","description":"Valor do diferimento.","minimum":0,"x-nullable":true}},"required":["vDif","pDif"]},"NfeSefazDevTrib":{"type":"object","description":"Grupo de Informações da devolução de tributos.","properties":{"vDevTrib":{"type":"number","description":"Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e\r\ngás natural e em outras hipóteses definidas no regulamento.","minimum":0,"x-nullable":true}},"required":["vDevTrib"]},"NfeSefazRed":{"type":"object","description":"Grupo de campos da redução de aliquota.","properties":{"pRedAliq":{"type":"number","description":"Percentual de redução de aliquota do cClassTrib.","minimum":0,"x-nullable":true},"pAliqEfet":{"type":"number","description":"Aliquota Efetiva que será aplicada a Base de Calculo (em percentual).","minimum":0,"x-nullable":true}},"required":["pAliqEfet","pRedAliq"]},"NfeSefazGIBSMun":{"type":"object","description":"Grupo de Informações do IBS no Município.","properties":{"pIBSMun":{"type":"number","description":"Aliquota do IBS Municipal (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/NfeSefazDif"},"gDevTrib":{"$ref":"#/definitions/NfeSefazDevTrib"},"gRed":{"$ref":"#/definitions/NfeSefazRed"},"vIBSMun":{"type":"number","description":"Valor do IBS Municipal.","minimum":0,"x-nullable":true}},"required":["vIBSMun","pIBSMun"]},"NfeSefazGCBS":{"type":"object","description":"Grupo de Tributação da CBS.","properties":{"pCBS":{"type":"number","description":"Aliquota da CBS (em percentual).","minimum":0,"x-nullable":true},"gDif":{"$ref":"#/definitions/NfeSefazDif"},"gDevTrib":{"$ref":"#/definitions/NfeSefazDevTrib"},"gRed":{"$ref":"#/definitions/NfeSefazRed"},"vCBS":{"type":"number","description":"Valor da CBS.","minimum":0,"x-nullable":true}},"required":["vCBS","pCBS"]},"NfeSefazTribRegular":{"type":"object","description":"Grupo de informações da Tributação Regular. Informar como seria a tributação caso não cumprida a condição resolutória/suspensiva. Exemplo 1: Art. 442, §4. Operações com ZFM e ALC. Exemplo 2: Operações com suspensão do tributo.","properties":{"CSTReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS.\r\nInformar qual seria o CST caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"cClassTribReg":{"type":"string","description":"Informar qual seria o cClassTrib caso não cumprida a condição resolutória/suspensiva.","x-nullable":true},"pAliqEfetRegIBSUF":{"type":"number","description":"Alíquota do IBS da UF.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSUF":{"type":"number","description":"Valor do IBS da UF.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegIBSMun":{"type":"number","description":"Alíquota do IBS do Município.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegIBSMun":{"type":"number","description":"Valor do IBS do Município.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"pAliqEfetRegCBS":{"type":"number","description":"Alíquota da CBS.\r\nInformar como seria a Alíquota caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true},"vTribRegCBS":{"type":"number","description":"Valor da CBS.\r\nInformar como seria o valor do Tributo caso não cumprida a condição resolutória/suspensiva.","minimum":0,"x-nullable":true}},"required":["vTribRegCBS","pAliqEfetRegCBS","vTribRegIBSMun","pAliqEfetRegIBSMun","vTribRegIBSUF","pAliqEfetRegIBSUF","cClassTribReg","CSTReg"]},"NfeSefazTribCompraGov":{"type":"object","description":"Grupo de informações da composição do valor do IBS e da CBS em compras governamental.","properties":{"pAliqIBSUF":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSUF":{"type":"number","description":"Valor que seria devido a UF, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqIBSMun":{"type":"number","minimum":0,"x-nullable":true},"vTribIBSMun":{"type":"number","description":"Valor que seria devido ao município, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true},"pAliqCBS":{"type":"number","minimum":0,"x-nullable":true},"vTribCBS":{"type":"number","description":"Valor que seria devido a CBS, sem aplicação do Art. 473. da LC 214/2025.","minimum":0,"x-nullable":true}},"required":["vTribCBS","vTribIBSMun","vTribIBSUF"]},"NfeSefazMonofasia":{"type":"object","description":"Informar essa opção da Choice para Monofasia (CST 620).","properties":{"gMonoPadrao":{"$ref":"#/definitions/NfeSefazGMonoPadrao"},"gMonoReten":{"$ref":"#/definitions/NfeSefazGMonoReten"},"gMonoRet":{"$ref":"#/definitions/NfeSefazGMonoRet"},"gMonoDif":{"$ref":"#/definitions/NfeSefazGMonoDif"},"vTotIBSMonoItem":{"type":"number","description":"Total de IBS monofásico do item.","minimum":0,"x-nullable":true},"vTotCBSMonoItem":{"type":"number","description":"Total da CBS monofásica do item.","minimum":0,"x-nullable":true}},"required":["vTotCBSMonoItem","vTotIBSMonoItem"]},"NfeSefazGMonoPadrao":{"type":"object","description":"Grupo de informações da Tributação Monofásica padrão.","properties":{"qBCMono":{"type":"number","description":"Quantidade tributada na monofasia.","minimum":0,"x-nullable":true},"adRemIBS":{"type":"number","description":"Alíquota ad rem do IBS.","minimum":0,"x-nullable":true},"adRemCBS":{"type":"number","description":"Alíquota ad rem da CBS.","minimum":0,"x-nullable":true},"vIBSMono":{"type":"number","description":"Valor do IBS monofásico.","minimum":0,"x-nullable":true},"vCBSMono":{"type":"number","description":"Valor da CBS monofásica.","minimum":0,"x-nullable":true}},"required":["vCBSMono","vIBSMono","adRemCBS","adRemIBS","qBCMono"]},"NfeSefazGMonoReten":{"type":"object","description":"Grupo de informações da Tributação Monofásica sujeita a retenção.","properties":{"qBCMonoReten":{"type":"number","description":"Quantidade tributada sujeita a retenção.","minimum":0,"x-nullable":true},"adRemIBSReten":{"type":"number","description":"Alíquota ad rem do IBS sujeito a retenção.","minimum":0,"x-nullable":true},"vIBSMonoReten":{"type":"number","description":"Valor do IBS monofásico sujeito a retenção.","minimum":0,"x-nullable":true},"adRemCBSReten":{"type":"number","description":"Alíquota ad rem da CBS sujeita a retenção.","minimum":0,"x-nullable":true},"vCBSMonoReten":{"type":"number","description":"Valor da CBS monofásica sujeita a retenção.","minimum":0,"x-nullable":true}},"required":["vCBSMonoReten","adRemCBSReten","vIBSMonoReten","adRemIBSReten","qBCMonoReten"]},"NfeSefazGMonoRet":{"type":"object","description":"Grupo de informações da Tributação Monofásica retida anteriormente.","properties":{"qBCMonoRet":{"type":"number","description":"Quantidade tributada retida anteriormente.","minimum":0,"x-nullable":true},"adRemIBSRet":{"type":"number","description":"Alíquota ad rem do IBS retido anteriormente.","minimum":0,"x-nullable":true},"vIBSMonoRet":{"type":"number","description":"Valor do IBS retido anteriormente.","minimum":0,"x-nullable":true},"adRemCBSRet":{"type":"number","description":"Alíquota ad rem da CBS retida anteriormente.","minimum":0,"x-nullable":true},"vCBSMonoRet":{"type":"number","description":"Valor da CBS retida anteriormente.","minimum":0,"x-nullable":true}},"required":["vCBSMonoRet","adRemCBSRet","vIBSMonoRet","adRemIBSRet","qBCMonoRet"]},"NfeSefazGMonoDif":{"type":"object","description":"Grupo de informações do diferimento da Tributação Monofásica.","properties":{"pDifIBS":{"type":"number","description":"Percentual do diferimento do imposto monofásico.","minimum":0,"x-nullable":true},"vIBSMonoDif":{"type":"number","description":"Valor do IBS monofásico diferido.","minimum":0,"x-nullable":true},"pDifCBS":{"type":"number","description":"Percentual do diferimento do imposto monofásico.","minimum":0,"x-nullable":true},"vCBSMonoDif":{"type":"number","description":"Valor da CBS monofásica diferida.","minimum":0,"x-nullable":true}},"required":["vCBSMonoDif","pDifCBS","vIBSMonoDif","pDifIBS"]},"NfeSefazTransfCred":{"type":"object","description":"Informar essa opção da Choice para o CST 800.","properties":{"vIBS":{"type":"number","description":"Valor do IBS a ser transferido.","minimum":0,"x-nullable":true},"vCBS":{"type":"number","description":"Valor da CBS a ser transferida.","minimum":0,"x-nullable":true}},"required":["vCBS","vIBS"]},"NfeSefazAjusteCompet":{"type":"object","description":"Informar essa opção da Choice para o CST 811.","properties":{"competApur":{"type":"string","description":"Ano e mês referência do período de apuração (AAAA-MM).","x-nullable":true},"vIBS":{"type":"number","description":"Valor do IBS.","minimum":0,"x-nullable":true},"vCBS":{"type":"number","description":"Valor da CBS.","minimum":0,"x-nullable":true}},"required":["vCBS","vIBS","competApur"]},"NfeSefazEstornoCred":{"type":"object","description":"Informado conforme indicador no cClassTrib.","properties":{"vIBSEstCred":{"type":"number","description":"Valor do IBS a ser estornado.","minimum":0,"x-nullable":true},"vCBSEstCred":{"type":"number","description":"Valor da CBS a ser estornada.","minimum":0,"x-nullable":true}},"required":["vCBSEstCred","vIBSEstCred"]},"NfeSefazCredPresOper":{"type":"object","description":"Crédito Presumido da Operação. Informado conforme indicador no cClassTrib.","properties":{"vBCCredPres":{"type":"number","description":"Valor da Base de Cálculo do Crédito Presumido da Operação.","minimum":0,"x-nullable":true},"cCredPres":{"type":"string","description":"Código de Classificação do Crédito Presumido do IBS e da CBS.","x-nullable":true},"gIBSCredPres":{"$ref":"#/definitions/NfeSefazCredPres"},"gCBSCredPres":{"$ref":"#/definitions/NfeSefazCredPres"}},"required":["cCredPres","vBCCredPres"]},"NfeSefazCredPres":{"type":"object","description":"Grupo de Informações do Crédito Presumido referente ao IBS, quando aproveitado pelo emitente do documento.","properties":{"pCredPres":{"type":"number","description":"Percentual do Crédito Presumido.","minimum":0,"x-nullable":true},"vCredPres":{"type":"number","description":"Valor do Crédito Presumido.","minimum":0,"x-nullable":true},"vCredPresCondSus":{"type":"number","description":"Valor do Crédito Presumido Condição Suspensiva, preencher apenas para cCredPres que possui indicação de Condição Suspensiva.","minimum":0,"x-nullable":true}},"required":["pCredPres"]},"NfeSefazCredPresIBSZFM":{"type":"object","description":"Classificação de acordo com o art. 450, § 1º, da LC 214/25 para o cálculo do crédito presumido na ZFM. Informado conforme indicador no cClassTrib.","properties":{"competApur":{"type":"string","description":"Ano e mês referência do período de apuração (AAAA-MM).","x-nullable":true},"tpCredPresIBSZFM":{"type":"integer","description":"Classificação de acordo com o art. 450, § 1º, da LC 214/25 para o cálculo do crédito presumido na ZFM.\r\n* 0 - Sem crédito presumido\r\n* 1 - Bens de consumo final (55%%)\r\n* 2 - Bens de capital (75%%)\r\n* 3 - Bens intermediários (90,25%%)\r\n* 4 - Bens de informática e outros definidos em legislação (100%%)\r\nOBS: Percentuais definidos no art. 450, § 1º, da LC 214/25 para o cálculo do crédito presumido.","x-nullable":true},"vCredPresIBSZFM":{"type":"number","description":"Valor do crédito presumido calculado sobre o saldo devedor apurado.","minimum":0,"x-nullable":true}},"required":["vCredPresIBSZFM","tpCredPresIBSZFM","competApur"]},"NfeSefazImpostoDevol":{"type":"object","properties":{"pDevol":{"type":"number","description":"Percentual de mercadoria devolvida.","maximum":100,"minimum":0,"x-nullable":true},"IPI":{"$ref":"#/definitions/NfeSefazImpostoDevol_IPI"}},"required":["IPI","pDevol"]},"NfeSefazImpostoDevol_IPI":{"type":"object","description":"Informação de IPI devolvido.","properties":{"vIPIDevol":{"type":"number","description":"Valor do IPI devolvido.","minimum":0,"x-nullable":true}},"required":["vIPIDevol"]},"NfeSefazObsItem":{"type":"object","description":"Grupo de observações de uso livre (para o item da NF-e).","properties":{"obsCont":{"$ref":"#/definitions/NfeSefazObsCont"},"obsFisco":{"$ref":"#/definitions/NfeSefazObsFisco"}}},"NfeSefazObsCont":{"type":"object","description":"Grupo de observações de uso livre (para o item da NF-e).","properties":{"xCampo":{"type":"string","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","maxLength":60,"minLength":1,"x-nullable":true}}},"NfeSefazObsFisco":{"type":"object","description":"Grupo de observações de uso livre (para o item da NF-e).","properties":{"xCampo":{"type":"string","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","maxLength":60,"minLength":1,"x-nullable":true}}},"NfeSefazDFeReferenciado":{"type":"object","description":"Referenciamento de item de outros DFe.","properties":{"chaveAcesso":{"type":"string","description":"Chave de Acesso do DFe referenciado.","maxLength":44,"x-nullable":true},"nItem":{"type":"integer","description":"Número do item do documento referenciado. Corresponde ao atributo nItem do elemento det do documento original.","maximum":990,"minimum":1,"x-nullable":true}},"required":["chaveAcesso"]},"NfeSefazTotal":{"type":"object","description":"Dados dos totais da NF-e.","properties":{"ICMSTot":{"$ref":"#/definitions/NfeSefazICMSTot"},"ISSQNtot":{"$ref":"#/definitions/NfeSefazISSQNtot"},"retTrib":{"$ref":"#/definitions/NfeSefazRetTrib"},"ISTot":{"$ref":"#/definitions/NfeSefazISTot"},"IBSCBSTot":{"$ref":"#/definitions/NfeSefazIBSCBSMonoTot"},"vNFTot":{"type":"number","description":"Valor Total da NF considerando os impostos por fora IBS, CBS e IS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}},"required":["ICMSTot"]},"NfeSefazICMSTot":{"type":"object","description":"Totais referentes ao ICMS.","properties":{"vBC":{"type":"number","description":"BC do ICMS.","minimum":0,"x-nullable":true},"vICMS":{"type":"number","description":"Valor Total do ICMS.","minimum":0,"x-nullable":true},"vICMSDeson":{"type":"number","description":"Valor Total do ICMS desonerado.","minimum":0,"x-nullable":true},"vFCPUFDest":{"type":"number","description":"Valor total do ICMS relativo ao Fundo de Combate à Pobreza (FCP) para a UF de destino.","minimum":0,"x-nullable":true},"vICMSUFDest":{"type":"number","description":"Valor total do ICMS de partilha para a UF do destinatário.","minimum":0,"x-nullable":true},"vICMSUFRemet":{"type":"number","description":"Valor total do ICMS de partilha para a UF do remetente.","minimum":0,"x-nullable":true},"vFCP":{"type":"number","description":"Valor Total do FCP (Fundo de Combate à Pobreza).","minimum":0,"x-nullable":true},"vBCST":{"type":"number","description":"BC do ICMS ST.","minimum":0,"x-nullable":true},"vST":{"type":"number","description":"Valor Total do ICMS ST.","minimum":0,"x-nullable":true},"vFCPST":{"type":"number","description":"Valor Total do FCP (Fundo de Combate à Pobreza) retido por substituição tributária.","minimum":0,"x-nullable":true},"vFCPSTRet":{"type":"number","description":"Valor Total do FCP (Fundo de Combate à Pobreza) retido anteriormente por substituição tributária.","minimum":0,"x-nullable":true},"qBCMono":{"type":"number","description":"Valor total da quantidade tributada do ICMS monofásico próprio.","minimum":0,"x-nullable":true},"vICMSMono":{"type":"number","description":"Valor total do ICMS monofásico próprio.","minimum":0,"x-nullable":true},"qBCMonoReten":{"type":"number","description":"Valor total da quantidade tributada do ICMS monofásico sujeito a retenção.","minimum":0,"x-nullable":true},"vICMSMonoReten":{"type":"number","description":"Valor total do ICMS monofásico sujeito a retenção.","minimum":0,"x-nullable":true},"qBCMonoRet":{"type":"number","description":"Valor total da quantidade tributada do ICMS monofásico retido anteriormente.","minimum":0,"x-nullable":true},"vICMSMonoRet":{"type":"number","description":"Valor do ICMS monofásico retido anteriormente.","minimum":0,"x-nullable":true},"vProd":{"type":"number","description":"Valor Total dos produtos e serviços.","minimum":0,"x-nullable":true},"vFrete":{"type":"number","description":"Valor Total do Frete.","minimum":0,"x-nullable":true},"vSeg":{"type":"number","description":"Valor Total do Seguro.","minimum":0,"x-nullable":true},"vDesc":{"type":"number","description":"Valor Total do Desconto.","minimum":0,"x-nullable":true},"vII":{"type":"number","description":"Valor Total do II.","minimum":0,"x-nullable":true},"vIPI":{"type":"number","description":"Valor Total do IPI.","minimum":0,"x-nullable":true},"vIPIDevol":{"type":"number","description":"Valor Total do IPI devolvido. Deve ser informado quando preenchido o Grupo Tributos Devolvidos na emissão de nota finNFe=4 (devolução) nas operações com não contribuintes do IPI. Corresponde ao total da soma dos campos id: UA04.","minimum":0,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS.","minimum":0,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS.","minimum":0,"x-nullable":true},"vOutro":{"type":"number","description":"Outras Despesas acessórias.","minimum":0,"x-nullable":true},"vNF":{"type":"number","description":"Valor Total da NF-e.","minimum":0,"x-nullable":true},"vTotTrib":{"type":"number","description":"Valor estimado total de impostos federais, estaduais e municipais.","minimum":0,"x-nullable":true}},"required":["vNF","vOutro","vCOFINS","vPIS","vIPIDevol","vIPI","vII","vDesc","vSeg","vFrete","vProd","vFCPSTRet","vFCPST","vST","vBCST","vFCP","vICMSDeson","vICMS","vBC"]},"NfeSefazISSQNtot":{"type":"object","description":"Totais referentes ao ISSQN.","properties":{"vServ":{"type":"number","description":"Valor Total dos Serviços sob não-incidência ou não tributados pelo ICMS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBC":{"type":"number","description":"Base de Cálculo do ISS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vISS":{"type":"number","description":"Valor Total do ISS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vPIS":{"type":"number","description":"Valor do PIS sobre serviços.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vCOFINS":{"type":"number","description":"Valor do COFINS sobre serviços.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"dCompet":{"type":"string","format":"date","description":"Data da prestação do serviço  (AAAA-MM-DD).","x-nullable":true},"vDeducao":{"type":"number","description":"Valor dedução para redução da base de cálculo.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vOutro":{"type":"number","description":"Valor outras retenções.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDescIncond":{"type":"number","description":"Valor desconto incondicionado.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vDescCond":{"type":"number","description":"Valor desconto condicionado.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vISSRet":{"type":"number","description":"Valor Total Retenção ISS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"cRegTrib":{"type":"integer","description":"Código do regime especial de tributação.","x-nullable":true}},"required":["dCompet"]},"NfeSefazRetTrib":{"type":"object","description":"Retenção de Tributos Federais.","properties":{"vRetPIS":{"type":"number","description":"Valor Retido de PIS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vRetCOFINS":{"type":"number","description":"Valor Retido de COFINS.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vRetCSLL":{"type":"number","description":"Valor Retido de CSLL.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBCIRRF":{"type":"number","description":"Base de Cálculo do IRRF.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vIRRF":{"type":"number","description":"Valor Retido de IRRF.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vBCRetPrev":{"type":"number","description":"Base de Cálculo da Retenção da Previdêncica Social.","minimum":0,"exclusiveMinimum":true,"x-nullable":true},"vRetPrev":{"type":"number","description":"Valor da Retenção da Previdêncica Social.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}}},"NfeSefazISTot":{"type":"object","description":"Valores totais da NF com Imposto Seletivo.","properties":{"vIS":{"type":"number","description":"Valor Total do Imposto Seletivo.","minimum":0,"x-nullable":true}},"required":["vIS"]},"NfeSefazIBSCBSMonoTot":{"type":"object","description":"Valores totais da NF com IBS / CBS.","properties":{"vBCIBSCBS":{"type":"number","description":"Total Base de Calculo.","minimum":0,"x-nullable":true},"gIBS":{"$ref":"#/definitions/NfeSefazGIBS"},"gCBS":{"$ref":"#/definitions/NfeSefazIBSCBSMonoTot_GCBS"},"gMono":{"$ref":"#/definitions/NfeSefazGMono"},"gEstornoCred":{"$ref":"#/definitions/NfeSefazGEstornoCred"}},"required":["vBCIBSCBS"]},"NfeSefazGIBS":{"type":"object","description":"Totalização do IBS.","properties":{"gIBSUF":{"$ref":"#/definitions/NfeSefazGIBS_GIBSUF"},"gIBSMun":{"$ref":"#/definitions/NfeSefazGIBS_GIBSMun"},"vIBS":{"type":"number","description":"Valor total do IBS.","minimum":0,"x-nullable":true},"vCredPres":{"type":"number","description":"Total do Crédito Presumido.","minimum":0,"x-nullable":true},"vCredPresCondSus":{"type":"number","description":"Total do Crédito Presumido Condição Suspensiva.","minimum":0,"x-nullable":true}},"required":["vCredPresCondSus","vCredPres","vIBS","gIBSMun","gIBSUF"]},"NfeSefazGIBS_GIBSUF":{"type":"object","description":"Totalização do IBS de competência da UF.","properties":{"vDif":{"type":"number","description":"Total do Diferimento.","minimum":0,"x-nullable":true},"vDevTrib":{"type":"number","description":"Total de devoluções de tributos.","minimum":0,"x-nullable":true},"vIBSUF":{"type":"number","description":"Valor total do IBS Estadual.","minimum":0,"x-nullable":true}},"required":["vIBSUF","vDevTrib","vDif"]},"NfeSefazGIBS_GIBSMun":{"type":"object","description":"Totalização do IBS de competência Municipal.","properties":{"vDif":{"type":"number","description":"Total do Diferimento.","minimum":0,"x-nullable":true},"vDevTrib":{"type":"number","description":"Total de devoluções de tributos.","minimum":0,"x-nullable":true},"vIBSMun":{"type":"number","description":"Valor total do IBS Municipal.","minimum":0,"x-nullable":true}},"required":["vIBSMun","vDevTrib","vDif"]},"NfeSefazIBSCBSMonoTot_GCBS":{"type":"object","description":"Totalização da CBS.","properties":{"vDif":{"type":"number","description":"Total do Diferimento.","minimum":0,"x-nullable":true},"vDevTrib":{"type":"number","description":"Total de devoluções de tributos.","minimum":0,"x-nullable":true},"vCBS":{"type":"number","description":"Valor total da CBS.","minimum":0,"x-nullable":true},"vCredPres":{"type":"number","description":"Total do Crédito Presumido.","minimum":0,"x-nullable":true},"vCredPresCondSus":{"type":"number","description":"Total do Crédito Presumido Condição Suspensiva.","minimum":0,"x-nullable":true}},"required":["vCredPresCondSus","vCredPres","vCBS","vDevTrib","vDif"]},"NfeSefazGMono":{"type":"object","description":"Totais da Monofasia.\r\nSó deverá ser utilizado para DFe modelos 55 e 65.","properties":{"vIBSMono":{"type":"number","description":"Valor total do IBS monofásico.","minimum":0,"x-nullable":true},"vCBSMono":{"type":"number","description":"Valor total da CBS monofásica.","minimum":0,"x-nullable":true},"vIBSMonoReten":{"type":"number","description":"Valor total do IBS monofásico sujeito a retenção.","minimum":0,"x-nullable":true},"vCBSMonoReten":{"type":"number","description":"Valor total da CBS monofásica sujeita a retenção.","minimum":0,"x-nullable":true},"vIBSMonoRet":{"type":"number","description":"Valor do IBS monofásico retido anteriormente.","minimum":0,"x-nullable":true},"vCBSMonoRet":{"type":"number","description":"Valor da CBS monofásica retida anteriormente.","minimum":0,"x-nullable":true}},"required":["vCBSMonoRet","vIBSMonoRet","vCBSMonoReten","vIBSMonoReten","vCBSMono","vIBSMono"]},"NfeSefazGEstornoCred":{"type":"object","description":"Totalização do estorno de crédito.","properties":{"vIBSEstCred":{"type":"number","description":"Valor total do IBS estornado.","minimum":0,"x-nullable":true},"vCBSEstCred":{"type":"number","description":"Valor total da CBS estornada.","minimum":0,"x-nullable":true}},"required":["vCBSEstCred","vIBSEstCred"]},"NfeSefazTransp":{"type":"object","description":"Dados dos transportes da NF-e.","properties":{"modFrete":{"type":"integer","description":"Modalidade do frete\r\n* 0 - Contratação do Frete por conta do Remetente (CIF)\r\n* 1 - Contratação do Frete por conta do destinatário/remetente (FOB)\r\n* 2 - Contratação do Frete por conta de terceiros\r\n* 3 - Transporte próprio por conta do remetente\r\n* 4 - Transporte próprio por conta do destinatário\r\n* 9 - Sem Ocorrência de transporte","x-nullable":true},"transporta":{"$ref":"#/definitions/NfeSefazTransporta"},"retTransp":{"$ref":"#/definitions/NfeSefazRetTransp"},"veicTransp":{"$ref":"#/definitions/NfeSefazVeiculo"},"reboque":{"type":"array","items":{"$ref":"#/definitions/NfeSefazVeiculo"},"maxItems":5},"vagao":{"type":"string","description":"Identificação do vagão (v2.0).","maxLength":20,"minLength":1,"x-nullable":true},"balsa":{"type":"string","description":"Identificação da balsa (v2.0).","maxLength":20,"minLength":1,"x-nullable":true},"vol":{"type":"array","items":{"$ref":"#/definitions/NfeSefazVol"},"maxItems":5000}},"required":["modFrete"]},"NfeSefazTransporta":{"type":"object","description":"Dados do transportador.","properties":{"CNPJ":{"type":"string","description":"CNPJ do transportador.","maxLength":14,"x-nullable":true},"CPF":{"type":"string","description":"CPF do transportador.","maxLength":11,"x-nullable":true},"xNome":{"type":"string","description":"Razão Social ou nome do transportador.","maxLength":60,"minLength":2,"x-nullable":true},"IE":{"type":"string","description":"Inscrição Estadual (v2.0).","maxLength":14,"x-nullable":true},"xEnder":{"type":"string","description":"Endereço completo.","maxLength":60,"minLength":1,"x-nullable":true},"xMun":{"type":"string","description":"Nome do munícipio.","maxLength":60,"minLength":1,"x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.","x-nullable":true}}},"NfeSefazRetTransp":{"type":"object","description":"Dados da retenção  ICMS do Transporte.","properties":{"vServ":{"type":"number","description":"Valor do Serviço.","minimum":0,"x-nullable":true},"vBCRet":{"type":"number","description":"BC da Retenção do ICMS.","minimum":0,"x-nullable":true},"pICMSRet":{"type":"number","description":"Alíquota da Retenção.","minimum":0,"x-nullable":true},"vICMSRet":{"type":"number","description":"Valor do ICMS Retido.","minimum":0,"x-nullable":true},"CFOP":{"type":"string","description":"Código Fiscal de Operações e Prestações.","x-nullable":true},"cMunFG":{"type":"string","description":"Código do Município de Ocorrência do Fato Gerador (utilizar a tabela do IBGE).","x-nullable":true}},"required":["cMunFG","CFOP","vICMSRet","pICMSRet","vBCRet","vServ"]},"NfeSefazVeiculo":{"type":"object","description":"Dados do veículo.","properties":{"placa":{"type":"string","description":"Placa do veículo (NT2011/004).","x-nullable":true},"UF":{"type":"string","description":"Sigla da UF.","x-nullable":true},"RNTC":{"type":"string","description":"Registro Nacional de Transportador de Carga (ANTT).","maxLength":20,"minLength":1,"x-nullable":true}},"required":["placa"]},"NfeSefazVol":{"type":"object","description":"Dados dos volumes.","properties":{"qVol":{"type":"integer","format":"int64","description":"Quantidade de volumes transportados.","x-nullable":true},"esp":{"type":"string","description":"Espécie dos volumes transportados.","maxLength":60,"minLength":1,"x-nullable":true},"marca":{"type":"string","description":"Marca dos volumes transportados.","maxLength":60,"minLength":1,"x-nullable":true},"nVol":{"type":"string","description":"Numeração dos volumes transportados.","maxLength":60,"minLength":1,"x-nullable":true},"pesoL":{"type":"number","description":"Peso líquido (em kg).","minimum":0,"x-nullable":true},"pesoB":{"type":"number","description":"Peso bruto (em kg).","minimum":0,"x-nullable":true},"lacres":{"type":"array","items":{"$ref":"#/definitions/NfeSefazLacres"},"maxItems":5000}}},"NfeSefazLacres":{"type":"object","properties":{"nLacre":{"type":"string","description":"Número dos Lacres.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["nLacre"]},"NfeSefazCobr":{"type":"object","description":"Dados da cobrança da NF-e.","properties":{"fat":{"$ref":"#/definitions/NfeSefazFat"},"dup":{"type":"array","items":{"$ref":"#/definitions/NfeSefazDup"},"maxItems":120}}},"NfeSefazFat":{"type":"object","description":"Dados da fatura.","properties":{"nFat":{"type":"string","description":"Número da fatura.","maxLength":60,"minLength":1,"x-nullable":true},"vOrig":{"type":"number","description":"Valor original da fatura.","minimum":0,"x-nullable":true},"vDesc":{"type":"number","description":"Valor do desconto da fatura.","minimum":0,"x-nullable":true},"vLiq":{"type":"number","description":"Valor líquido da fatura.","minimum":0,"x-nullable":true}}},"NfeSefazDup":{"type":"object","description":"Dados das duplicatas NT 2011/004.","properties":{"nDup":{"type":"string","description":"Número da duplicata.","maxLength":60,"minLength":1,"x-nullable":true},"dVenc":{"type":"string","format":"date","description":"Data de vencimento da duplicata (AAAA-MM-DD).","x-nullable":true},"vDup":{"type":"number","description":"Valor da duplicata.","minimum":0,"exclusiveMinimum":true,"x-nullable":true}},"required":["vDup"]},"NfeSefazPag":{"type":"object","description":"Dados de Pagamento. Obrigatório apenas para (NFC-e) NT 2012/004.","properties":{"detPag":{"type":"array","items":{"$ref":"#/definitions/NfeSefazDetPag"},"maxItems":100,"minItems":1},"vTroco":{"type":"number","description":"Valor do Troco.","minimum":0,"x-nullable":true}},"required":["detPag"]},"NfeSefazDetPag":{"type":"object","description":"Grupo de detalhamento da forma de pagamento.","properties":{"indPag":{"type":"integer","description":"Indicador da Forma de Pagamento:0-Pagamento à Vista\r\n* 1 - Pagamento à Prazo","x-nullable":true},"tPag":{"type":"string","description":"Forma de Pagamento:.","x-nullable":true},"xPag":{"type":"string","description":"Descrição do Meio de Pagamento.","maxLength":60,"minLength":2,"x-nullable":true},"vPag":{"type":"number","description":"Valor do Pagamento. Esta tag poderá ser omitida quando a tag tPag=90 (Sem Pagamento), caso contrário deverá ser preenchida.","minimum":0,"x-nullable":true},"dPag":{"type":"string","format":"date","description":"Data do Pagamento.","x-nullable":true},"CNPJPag":{"type":"string","description":"CNPJ transacional do pagamento - Preencher informando o CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido quando a emissão do documento fiscal ocorrer em estabelecimento distinto.","maxLength":14,"x-nullable":true},"UFPag":{"type":"string","description":"UF do CNPJ do estabelecimento onde o pagamento foi processado/transacionado/recebido.","x-nullable":true},"card":{"$ref":"#/definitions/NfeSefazCard"}},"required":["vPag","tPag"]},"NfeSefazCard":{"type":"object","description":"Grupo de Cartões, PIX, Boletos e outros Pagamentos Eletrônicos.","properties":{"tpIntegra":{"type":"integer","description":"Tipo de Integração do processo de pagamento com o sistema de automação da empresa:\r\n* 1 - Pagamento integrado com o sistema de automação da empresa (Ex.: equipamento TEF, Comércio Eletrônico, POS Integrado)\r\n* 2 - Pagamento não integrado com o sistema de automação da empresa (Ex.: equipamento POS Simples)","x-nullable":true},"CNPJ":{"type":"string","description":"CNPJ da instituição de pagamento.","maxLength":14,"x-nullable":true},"tBand":{"type":"string","description":"Bandeira da operadora de cartão.","x-nullable":true},"cAut":{"type":"string","description":"Número de autorização da operação com cartões, PIX, boletos e outros pagamentos eletrônicos.","maxLength":128,"minLength":1,"x-nullable":true},"CNPJReceb":{"type":"string","description":"CNPJ do beneficiário do pagamento.","maxLength":14,"x-nullable":true},"idTermPag":{"type":"string","description":"Identificador do terminal de pagamento.","maxLength":40,"minLength":1,"x-nullable":true}},"required":["tpIntegra"]},"NfeSefazInfIntermed":{"type":"object","description":"Grupo de Informações do Intermediador da Transação.","properties":{"CNPJ":{"type":"string","description":"CNPJ do Intermediador da Transação (agenciador, plataforma de delivery, marketplace e similar) de serviços e de negócios.","maxLength":14,"x-nullable":true},"idCadIntTran":{"type":"string","description":"Identificador cadastrado no intermediador.","maxLength":60,"minLength":2,"x-nullable":true}},"required":["idCadIntTran","CNPJ"]},"NfeSefazInfAdic":{"type":"object","description":"Informações adicionais da NF-e.","properties":{"infAdFisco":{"type":"string","description":"Informações adicionais de interesse do Fisco (v2.0).","maxLength":2000,"minLength":1,"x-nullable":true},"infCpl":{"type":"string","description":"Informações complementares de interesse do Contribuinte.","maxLength":5000,"minLength":1,"x-nullable":true},"obsCont":{"type":"array","items":{"$ref":"#/definitions/NfeSefazInfAdic_ObsCont"},"maxItems":10},"obsFisco":{"type":"array","items":{"$ref":"#/definitions/NfeSefazInfAdic_ObsFisco"},"maxItems":10},"procRef":{"type":"array","items":{"$ref":"#/definitions/NfeSefazProcRef"},"maxItems":100}}},"NfeSefazInfAdic_ObsCont":{"type":"object","description":"Campo de uso livre do contribuinte\r\ninformar o nome do campo no atributo xCampo\r\ne o conteúdo do campo no xTexto.","properties":{"xCampo":{"type":"string","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","maxLength":60,"minLength":1,"x-nullable":true}}},"NfeSefazInfAdic_ObsFisco":{"type":"object","description":"Campo de uso exclusivo do Fisco\r\ninformar o nome do campo no atributo xCampo\r\ne o conteúdo do campo no xTexto.","properties":{"xCampo":{"type":"string","maxLength":20,"minLength":1,"x-nullable":true},"xTexto":{"type":"string","maxLength":60,"minLength":1,"x-nullable":true}}},"NfeSefazProcRef":{"type":"object","description":"Grupo de informações do  processo referenciado.","properties":{"nProc":{"type":"string","description":"Indentificador do processo ou ato\r\nconcessório.","maxLength":60,"minLength":1,"x-nullable":true},"indProc":{"type":"integer","description":"Origem do processo, informar com:\r\n* 0 - SEFAZ\r\n* 1 - Justiça Federal\r\n* 2 - Justiça Estadual\r\n* 3 - Secex/RFB\r\n* 4 - CONFAZ\r\n* 9 - Outros","x-nullable":true},"tpAto":{"type":"string","description":"Tipo do ato concessório\r\nPara origem do Processo na SEFAZ (indProc=0), informar o\r\ntipo de ato concessório:\r\n* 08 - Termo de Acordo\r\n* 10 - Regime Especial\r\n* 12 - Autorização específica\r\n* 14 - Ajuste SINIEF\r\n* 15 - Convênio ICMS","x-nullable":true}},"required":["indProc","nProc"]},"NfeSefazExporta":{"type":"object","description":"Informações de exportação.","properties":{"UFSaidaPais":{"type":"string","description":"Sigla da UF de Embarque ou de transposição de fronteira.","x-nullable":true},"xLocExporta":{"type":"string","description":"Local de Embarque ou de transposição de fronteira.","maxLength":60,"minLength":1,"x-nullable":true},"xLocDespacho":{"type":"string","description":"Descrição do local de despacho.","maxLength":60,"minLength":1,"x-nullable":true}},"required":["xLocExporta","UFSaidaPais"]},"NfeSefazCompra":{"type":"object","description":"Informações de compras  (Nota de Empenho, Pedido e Contrato).","properties":{"xNEmp":{"type":"string","description":"Informação da Nota de Empenho de compras públicas (NT2011/004).","maxLength":22,"minLength":1,"x-nullable":true},"xPed":{"type":"string","description":"Informação do pedido.","maxLength":60,"minLength":1,"x-nullable":true},"xCont":{"type":"string","description":"Informação do contrato.","maxLength":60,"minLength":1,"x-nullable":true}}},"NfeSefazCana":{"type":"object","description":"Informações de registro aquisições de cana.","properties":{"safra":{"type":"string","description":"Identificação da safra.","maxLength":9,"minLength":4,"x-nullable":true},"ref":{"type":"string","description":"Mês e Ano de Referência, formato: MM/AAAA.","x-nullable":true},"forDia":{"type":"array","items":{"$ref":"#/definitions/NfeSefazForDia"},"maxItems":31,"minItems":1},"qTotMes":{"type":"number","description":"Total do mês.","minimum":0,"x-nullable":true},"qTotAnt":{"type":"number","description":"Total Anterior.","minimum":0,"x-nullable":true},"qTotGer":{"type":"number","description":"Total Geral.","minimum":0,"x-nullable":true},"deduc":{"type":"array","items":{"$ref":"#/definitions/NfeSefazDeduc"},"maxItems":10},"vFor":{"type":"number","description":"Valor  dos fornecimentos.","minimum":0,"x-nullable":true},"vTotDed":{"type":"number","description":"Valor Total das Deduções.","minimum":0,"x-nullable":true},"vLiqFor":{"type":"number","description":"Valor Líquido dos fornecimentos.","minimum":0,"x-nullable":true}},"required":["vLiqFor","vTotDed","vFor","qTotGer","qTotAnt","qTotMes","forDia","ref","safra"]},"NfeSefazForDia":{"type":"object","description":"Fornecimentos diários.","properties":{"dia":{"type":"integer","description":"Número do dia.","maximum":31,"minimum":1,"x-nullable":true},"qtde":{"type":"number","description":"Quantidade em quilogramas - peso líquido.","minimum":0,"x-nullable":true}},"required":["qtde","dia"]},"NfeSefazDeduc":{"type":"object","description":"Deduções - Taxas e Contribuições.","properties":{"xDed":{"type":"string","description":"Descrição da Dedução.","maxLength":60,"minLength":1,"x-nullable":true},"vDed":{"type":"number","description":"valor da dedução.","minimum":0,"x-nullable":true}},"required":["vDed","xDed"]},"NfeSefazInfRespTec":{"type":"object","description":"Informações do Responsável Técnico pela emissão do DF-e.","properties":{"CNPJ":{"type":"string","description":"CNPJ.","maxLength":14,"x-nullable":true},"xContato":{"type":"string","description":"Informar o nome da pessoa a ser contatada na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico.","maxLength":60,"minLength":2,"x-nullable":true},"email":{"type":"string","description":"Informar o e-mail da pessoa a ser contatada na empresa desenvolvedora do sistema.","maxLength":60,"minLength":6,"x-nullable":true},"fone":{"type":"string","description":"Informar o telefone da pessoa a ser contatada na empresa desenvolvedora do sistema. Preencher com o Código DDD + número do telefone.","x-nullable":true},"idCSRT":{"type":"integer","description":"Identificador do CSRT utilizado para montar o hash do CSRT.","maximum":99,"minimum":0,"x-nullable":true},"CSRT":{"type":"string","description":"Código de Segurança do Responsável Técnico utilizado para montar o hash do CSRT.","x-nullable":true},"hashCSRT":{"type":"string","description":"O hashCSRT é o resultado da função hash (SHA-1 - Base64) do CSRT fornecido pelo fisco mais a Chave de Acesso da NFe.\r\n\r\n*Se não informado, será calculado automaticamente, desde que os campos `idCSRT` e `CSRT` sejam fornecidos.*","maxLength":28,"x-nullable":true}},"required":["fone","email","xContato","CNPJ"]},"NfeSefazInfSolicNFF":{"type":"object","description":"Grupo para informações da solicitação da NFF.","properties":{"xSolic":{"type":"string","description":"Solicitação do pedido de emissão da NFF.","maxLength":5000,"minLength":2,"x-nullable":true}},"required":["xSolic"]},"NfeSefazAgropecuario":{"type":"object","description":"Produtos Agropecurários Animais, Vegetais e Florestais.","properties":{"defensivo":{"type":"array","items":{"$ref":"#/definitions/NfeSefazDefensivo"},"maxItems":20},"guiaTransito":{"$ref":"#/definitions/NfeSefazGuiaTransito"}}},"NfeSefazDefensivo":{"type":"object","description":"Defensivo Agrícola / Agrotóxico.","properties":{"nReceituario":{"type":"string","description":"Número do Receituário ou Receita do Defensivo / Agrotóxico.","maxLength":30,"minLength":1,"x-nullable":true},"CPFRespTec":{"type":"string","description":"CPF do Responsável Técnico pelo receituário.","maxLength":11,"x-nullable":true}},"required":["CPFRespTec","nReceituario"]},"NfeSefazGuiaTransito":{"type":"object","description":"Guias De Trânsito de produtos agropecurários animais, vegetais e de origem florestal.","properties":{"tpGuia":{"type":"integer","description":"Tipo da Guia: 1 - GTA; 2 - TTA; 3 - DTA; 4 - ATV; 5 - PTV; 6 - GTV; 7 - Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG).","x-nullable":true},"UFGuia":{"type":"string","x-nullable":true},"serieGuia":{"type":"string","description":"Série da Guia.","maxLength":9,"minLength":1,"x-nullable":true},"nGuia":{"type":"string","description":"Número da Guia.","x-nullable":true}},"required":["nGuia","tpGuia"]},"NfeSefazInfNFeSupl":{"type":"object","description":"Informações suplementares Nota Fiscal.","properties":{"qrCode":{"type":"string","description":"Texto com o QR-Code impresso no DANFE NFC-e.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":1000,"minLength":60,"x-nullable":true},"urlChave":{"type":"string","description":"Informar a URL da \"Consulta por chave de acesso da NFC-e\". A mesma URL que deve estar informada no DANFE NFC-e para consulta por chave de acesso.\r\n\r\n*Geramos automaticamente quando nenhum valor é informado.*","maxLength":85,"minLength":21,"x-nullable":true}}},"DfePedidoEnvioEmail":{"type":"object","properties":{"destinatarios":{"type":"array","description":"Lista de endereços de email para envio dos arquivos.\r\n\r\n*Caso nenhum email seja informado, será utilizado o email do destinatário do documento fiscal.*","items":{"$ref":"#/definitions/EnderecoEmail"},"maxItems":10}}},"EnderecoEmail":{"type":"object","properties":{"email":{"type":"string","description":"Email do destinatário."}},"required":["email"]},"EmailStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID único gerado pela API para este email.\r\n\r\nUtilize-o no endpoint de <a href=\"#tag/Email/operation/ConsultarEmail\">consulta de email</a>\r\npara obter informações detalhadas sobre o envio do email e\r\nrastrear todos os eventos relacionados, como envio, entrega, falhas e outros\r\neventos relevantes."},"status":{"type":"string","enum":["pending","sending","sent","delivered","delivery_delayed","bounced","complained","rejected","cancelled","failed"]},"status_message":{"type":"string","x-nullable":true}},"required":["id"]},"NfePedidoCancelamento":{"type":"object","properties":{"justificativa":{"type":"string","description":"Justificativa para o cancelamento. Preencheremos automaticamente, caso esteja em branco."}}},"NfePedidoCartaCorrecao":{"type":"object","properties":{"correcao":{"type":"string","description":"Correção a ser considerada.","maxLength":1000}}},"DfeCartaCorrecao":{"type":"object","properties":{"correcao":{"type":"string","description":"Correção a ser considerada."},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"DfePedidoInutilizacao":{"type":"object","properties":{"ambiente":{"type":"string","description":"Identificação do Ambiente.","enum":["homologacao","producao"]},"cnpj":{"type":"string","description":"CNPJ do emitente."},"ano":{"type":"integer","description":"Ano de inutilização da numeração."},"serie":{"type":"integer","description":"Série da NF-e.","maximum":999,"minimum":0},"numero_inicial":{"type":"integer","description":"Número da NF-e inicial.","maximum":999999999,"minimum":1},"numero_final":{"type":"integer","description":"Número da NF-e final.","maximum":999999999,"minimum":1},"justificativa":{"type":"string","description":"Justificativa do pedido de inutilização.","maxLength":255,"minLength":15}},"required":["justificativa","numero_final","numero_inicial","serie","ano","cnpj","ambiente"]},"DfeInutilizacao":{"type":"object","properties":{"cnpj":{"type":"string"},"ano":{"type":"integer"},"modelo":{"type":"integer"},"serie":{"type":"integer"},"numero_inicial":{"type":"integer"},"numero_final":{"type":"integer"},"justificativa":{"type":"string"},"id":{"type":"string","description":"ID único gerado pela API para este evento."},"ambiente":{"type":"string","description":"Identificação do ambiente.","enum":["homologacao","producao"]},"status":{"type":"string","description":"Status do Evento.","enum":["pendente","registrado","rejeitado","erro"]},"autor":{"$ref":"#/definitions/DfeAutorEvento","description":"Identificação do autor do evento."},"chave_acesso":{"type":"string","description":"Chave de Acesso do documento vinculado ao evento."},"data_evento":{"type":"string","format":"date-time","description":"Data e hora do Evento."},"numero_sequencial":{"type":"integer","description":"Sequencial do evento para o mesmo tipo de evento."},"data_recebimento":{"type":"string","format":"date-time","description":"Data e hora do recebimento do Evento pela SEFAZ.","x-nullable":true},"codigo_status":{"type":"integer","description":"Código do status de registro do Evento."},"motivo_status":{"type":"string","description":"Descrição literal do status do registro do Evento."},"numero_protocolo":{"type":"string","description":"Número do Protocolo de registro do Evento."},"codigo_mensagem":{"type":"integer","description":"Código da Mensagem."},"mensagem":{"type":"string","description":"Mensagem da SEFAZ para o emissor."},"tipo_evento":{"type":"string"}}},"DfeEventoListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/DfeEvento"}}}},"CnpjEmpresa":{"type":"object","properties":{"cnpj":{"type":"string","description":"Número de inscrição do CNPJ."},"razao_social":{"type":"string","description":"Nome empresarial da pessoa jurídica."},"nome_fantasia":{"type":"string","description":"Corresponde ao nome fantasia."},"data_inicio_atividade":{"type":"string","format":"date","description":"Data de início da atividade."},"matriz":{"type":"boolean","description":"Indicador de matriz/filial:\r\n* `true` - É matriz\r\n* `false` - É filial"},"natureza_juridica":{"$ref":"#/definitions/CnpjNaturezaJuridica"},"capital_social":{"type":"number","description":"Capital social da empresa."},"porte":{"$ref":"#/definitions/CnpjPorteEmpresa"},"ente_federativo_responsavel":{"type":"string","description":"O ente federativo responsável é preenchido para os casos de órgãos e\r\nentidades do grupo de natureza jurídica 1XXX. Para as demais naturezas,\r\neste atributo fica em branco."},"situacao_cadastral":{"$ref":"#/definitions/CnpjSituacaoCadastral"},"motivo_situacao_cadastral":{"$ref":"#/definitions/CnpjMotivoSituacaoCadastral"},"nome_da_cidade_no_exterior":{"type":"string","description":"Nome da cidade no exterior."},"pais":{"$ref":"#/definitions/CnpjPais"},"atividade_principal":{"$ref":"#/definitions/CnpjCnae"},"atividades_secundarias":{"type":"array","items":{"$ref":"#/definitions/CnpjCnaeSecundario"}},"endereco":{"$ref":"#/definitions/CnpjEndereco"},"telefones":{"type":"array","items":{"$ref":"#/definitions/CnpjTelefone"}},"email":{"type":"string","description":"E-mail do contribuinte."},"situacao_especial":{"$ref":"#/definitions/CnpjSituacaoEspecial"},"simples":{"$ref":"#/definitions/CnpjOpcaoSimples"},"simei":{"$ref":"#/definitions/CnpjOpcaoSimei"},"socios":{"type":"array","items":{"$ref":"#/definitions/CnpjSocio"}}}},"CnpjNaturezaJuridica":{"type":"object","description":"Natureza jurídica.","properties":{"codigo":{"type":"string","description":"Código da natureza jurídica."},"descricao":{"type":"string","description":"Nome da natureza jurídica."}}},"CnpjPorteEmpresa":{"type":"object","description":"Porte da empresa.","properties":{"codigo":{"type":"string","description":"Código do porte da empresa."},"descricao":{"type":"string","description":"Descrição do porte da empresa."}}},"CnpjSituacaoCadastral":{"type":"object","description":"Situação cadastral.","properties":{"data":{"type":"string","format":"date","description":"Data do evento da situação cadastral."},"codigo":{"type":"string","description":"Código da situação cadastral."},"descricao":{"type":"string","description":"Descrição da situação cadastral."}}},"CnpjMotivoSituacaoCadastral":{"type":"object","description":"Motivo da situação cadastral.","properties":{"data":{"type":"string","format":"date","description":"Data do evento."},"codigo":{"type":"string","description":"Código do motivo da situação cadastral."},"descricao":{"type":"string","description":"Descrição do motivo da situação cadastral."}}},"CnpjPais":{"type":"object","description":"País.","properties":{"codigo":{"type":"string","description":"Código do país."},"descricao":{"type":"string","description":"Nome do país."}}},"CnpjCnae":{"type":"object","description":"Atividade econômica principal do estabelecimento.","properties":{"codigo":{"type":"string","description":"Código da atividade econômica."},"descricao":{"type":"string","description":"Nome da atividade econômica."}}},"CnpjCnaeSecundario":{"type":"object","description":"Atividade econômica secundária do estabelecimento.","properties":{"codigo":{"type":"string","description":"Código da atividade econômica."},"descricao":{"type":"string","description":"Nome da atividade econômica."}}},"CnpjEndereco":{"type":"object","description":"Endereço do estabelecimento.","properties":{"tipo_logradouro":{"type":"string","description":"Descrição do tipo de logradouro."},"logradouro":{"type":"string","description":"Nome do logradouro onde se localiza o estabelecimento."},"numero":{"type":"string","description":"Número onde se localiza o estabelecimento. Quando não houver\r\npreenchimento do número haverá ‘S/N’."},"complemento":{"type":"string","description":"Complemento para o endereço de localização do estabelecimento."},"bairro":{"type":"string","description":"Bairro onde se localiza o estabelecimento."},"cep":{"type":"string","description":"Código de endereçamento postal referente ao logradouro no qual o\r\nestabelecimento esta localizado."},"uf":{"type":"string","description":"Sigla da unidade da federação em que se encontra o estabelecimento."},"municipio":{"$ref":"#/definitions/CnpjMunicipio"}}},"CnpjMunicipio":{"type":"object","description":"Município de jurisdição onde se encontra o estabelecimento.","properties":{"codigo_tom":{"type":"string","description":"Código TOM do município."},"codigo_ibge":{"type":"string","description":"Código IBGE do município."},"descricao":{"type":"string","description":"Nome do município."}}},"CnpjTelefone":{"type":"object","description":"Telefone do estabelecimento.","properties":{"ddd":{"type":"string","description":"Código de DDD (Discagem Direta à Distância)"},"numero":{"type":"string","description":"Número do telefone."}}},"CnpjSituacaoEspecial":{"type":"object","description":"Situação especial da empresa.","properties":{"data":{"type":"string","format":"date","description":"Data em que a empresa entrou em situação especial."},"codigo":{"type":"string","description":"Código da situação especial da empresa."},"descricao":{"type":"string","description":"Descrição da situação especial da empresa."}}},"CnpjOpcaoSimples":{"type":"object","description":"Informações da opção do Simples Nacional.","properties":{"optante":{"type":"boolean","description":"Indicador da existência da opção pelo Simples Nacional:\r\n* `true` - É optante.\r\n* `false` - Não é optante."},"data_opcao":{"type":"string","format":"date","description":"Data da opção pelo Simples Nacional.","x-nullable":true},"data_exclusao":{"type":"string","format":"date","description":"Data da exclusão do Simples Nacional.","x-nullable":true}}},"CnpjOpcaoSimei":{"type":"object","description":"Informações da opção pelo MEI.","properties":{"optante":{"type":"boolean","description":"Indicador da existência da opção pelo MEI:\r\n* `true` - É optante.\r\n* `false` - Não é optante."},"data_opcao":{"type":"string","format":"date","description":"Data da opção pelo MEI.","x-nullable":true},"data_exclusao":{"type":"string","format":"date","description":"Data da exclusão do MEI.","x-nullable":true}}},"CnpjSocio":{"type":"object","description":"Quadro Societário.","properties":{"identificador_socio":{"$ref":"#/definitions/CnpjIdentificadorSocio"},"nome":{"type":"string","description":"Nome do sócio pessoa física ou a razão social e/ou nome empresarial da\r\npessoa jurídica e/ou nome do sócio/razão social do sócio estrangeiro."},"cpf_cnpj":{"type":"string","description":"CPF ou CNPJ do sócio (sócio estrangeiro não tem esta informação)."},"qualificacao":{"$ref":"#/definitions/CnpjQualificacaoSocio"},"data_entrada_sociedade":{"type":"string","format":"date","description":"Data de entrada na sociedade."},"pais":{"$ref":"#/definitions/CnpjPais"},"representante_legal":{"$ref":"#/definitions/CnpjRepresentanteLegal"},"faixa_etaria":{"$ref":"#/definitions/CnpjFaixaEtaria"}}},"CnpjIdentificadorSocio":{"type":"object","description":"Identificador de sócio.","properties":{"codigo":{"type":"string","description":"Código do identificador do sócio."},"descricao":{"type":"string","description":"Descrição do identificador do sócio."}}},"CnpjQualificacaoSocio":{"type":"object","description":"Qualificação.","properties":{"codigo":{"type":"string","description":"Código da qualificação do sócio."},"descricao":{"type":"string","description":"Nome da qualificação do sócio."}}},"CnpjRepresentanteLegal":{"type":"object","description":"Representante legal.","properties":{"cpf":{"type":"string","description":"Número do cpf do representante legal."},"nome":{"type":"string","description":"Nome do representante legal."},"qualificacao":{"$ref":"#/definitions/CnpjQualificacaoSocio","description":"Qualificação do representante legal."}}},"CnpjFaixaEtaria":{"type":"object","description":"Faixa etária.","properties":{"codigo":{"type":"string","description":"Código correspondente à faixa etária do sócio."},"descricao":{"type":"string","description":"Descrição correspondente à faixa etária do sócio."}}},"CnpjListagem":{"type":"object","properties":{"@count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/CnpjEmpresa"}}}},"CepEndereco":{"type":"object","properties":{"bairro":{"type":"string"},"cep":{"type":"string"},"codigo_ibge":{"type":"string"},"complemento":{"type":"string"},"logradouro":{"type":"string"},"municipio":{"type":"string"},"tipo_logradouro":{"type":"string"},"uf":{"type":"string"}}}},"security":[{"jwt":[]},{"oauth2":[]}],"x-tagGroups":[{"name":"Geral","tags":["Empresa","Conta"]},{"name":"Documentos Fiscais","tags":["CteOs","Nfse","Dce","Nfcom","Cte","Mdfe","Nfe","Nfce"]},{"name":"Distribuição DF-e","tags":["Distribuição NF-e"]},{"name":"Auxiliares","tags":["Debug","Email","Cnpj","Cep"]}]}