DestinatarioNfeSimplificadaInputModel

object

Dados do destinatário da NFe.

* Additional properties are NOT allowed.
tipoDocumentostring

Tipo de documento.

Allowed values:CpfCnpjIdEstrangeiro

documentostringrequired

Documento do destinatário.

>= 1 characters

nomestringrequired

Nome do destinatário.

>= 2 characters<= 60 characters

enderecoobjectrequired

Endereço do destinatário da NFe.

* Additional properties are NOT allowed.
Show Child Parameters
telefonestring

Telefone do destinatário.

indicadorInscricaostring

Indicador de inscrição estadual do destinatário.

Allowed values:ContribuinteIcmsContribuinteIsentoIcmsNaoContribuinte

inscricaoEstadualstring

Inscrição estadual do destinatário.

inscricaoSuframastring

Inscrição SUFRAMA.

inscricaoMunicipalstring

Inscrição municipal.

emailstring

Email do destinatário.

Example

DetalheConsultaCatalogoFiscalViewModel

object

Dados do detalhe das consultas realizadas internamente no catálogo fiscal.

* Additional properties are NOT allowed.
idstring(uuid)

Identificador interno da consulta no histórico.

fontestring

Fonte do dado consultado.

tipoConsultastring

Tipo de consulta realizada na api do catálogo fiscal.

Allowed values:ConsultaDetalhadaEanConsultaResumidaDescricaoListarAlterados

filtrostring

Valor do filtro utilizado.

dataConsultastring(date-time)

Data da consulta.

statusConsultastring

Status de retorno da consulta no catálogo fiscal.

Allowed values:SucessoNaoEncontradoFalha

jsonEnviostring

JSON de envio para o Catálogo Fiscal.

jsonRetornostring

JSON de retorno recebido do Catálogo Fiscal.

mensagemFalhastring

Mensagem detalhada em caso de falha na consulta.

Example

DetalheConsultasProdutoVisaoAplicacaoViewModel

object

Dados detalhados da consulta realizada pelo emissor exibidos pela aplicação.

* Additional properties are NOT allowed.
idstring(uuid)

Identificador interno da consulta no histórico.

modoConsultastring

Tipo de consulta realizada pelo emissor.

Allowed values:ConsultaProdutoEmissaoDeNotaFiscal

tipoFiltrostring

Tipo de filtro do catálogo de produto.

Allowed values:EanDescricaoSimilarHash

filtrostring

Valor do filtro utilizado.

dataConsultastring(date-time)

Data da consulta.

parametrosConsultastring

Parâmetros detalhados da consulta.

statusConsultastring

Status de retorno da consulta do produto.

Allowed values:SucessoNaoEncontradoFalha

hashstring

Hash do resultado da consulta.

jsonResultadoInformadostring

JSON contendo o resultado informado.

bilhetadoboolean

Indica se a consulta foi bilhetada.

Example

DetalheConsultasProdutoVisaoCrmViewModel

object

Dados detalhados da consulta realizada pelo emissor exibidos pela console CRM.

* Additional properties are NOT allowed.
idstring(uuid)

Identificador interno da consulta no histórico.

modoConsultastring

Tipo de consulta realizada pelo emissor.

Allowed values:ConsultaProdutoEmissaoDeNotaFiscal

tipoFiltrostring

Tipo de filtro do catálogo de produto.

Allowed values:EanDescricaoSimilarHash

filtrostring

Valor do filtro utilizado.

dataConsultastring(date-time)

Data da consulta.

parametrosConsultastring

Parâmetros detalhados da consulta.

statusConsultastring

Status de retorno da consulta do produto.

Allowed values:SucessoNaoEncontradoFalha

fonteInformacaostring

Origem do resultado obtido na consulta.

Allowed values:CacheCatalogoFiscal

jsonCatalogoFiscalEnviostring

JSON de envio para o Catálogo Fiscal.

jsonCatalogoFiscalRetornostring

JSON de retorno recebido do Catálogo Fiscal.

hashstring

Hash do resultado da consulta.

jsonResultadoInformadostring

JSON contendo o resultado informado.

mensagemFalhastring

Mensagem detalhada em caso de falha na consulta.

bilhetadoboolean

Indica se a consulta foi bilhetada.

Example

DownloadXmlViewModel

object

Dados da solicitação de download do XML.

* Additional properties are NOT allowed.
idstring(uuid)

Identificador da solicitação do download.

statusstring

Status do processamento da solicitação de download de XML.

Allowed values:PendenteEmProcessamentoConcluidoFalhaExpirado

dataSolicitacaostring(date-time)

Data de solicitação do download.

inscricaoEstadualstring

Filtrar pela inscrição estadual do emissor da nota fiscal.

buscastring

Filtro de busca genérica (dados do destinatário, transportador, chave de acesso, intermediador ou número do documento).

dataIniciostring(date)

Filtrar pela data de emissão da nota “a partir de”.

dataFimstring(date)

Filtrar pela data de emissão da nota “até”.

modelosDocumentoarray[string]

Modelo de documentos solicitados para download.

Allowed values:NfeNfce

mensagemFalhastring

Mensagem em caso de falha.

dataHoraProcessamentostring(date-time)

Data e hora do processamento.

statusCallbackstring

Status do envio de callback.

Allowed values:NaoRealizadoSucessoFalha

urlCallbackstring

URL de callback do solicitante.

urlDownloadstring

Url com link de download dos arquivos XMLs.

Example