Consulta de dados de Documento Fiscal Eletrônico (DF-e)
Serviço para consultar os dados de um documento fiscal eletrônico coletados por uma Avaliação previamente solicitada.
Consulta de documento fiscal
Path parameters
validacao_idstringRequired
Valor para o uuid
Header parameters
authorizationstringRequiredExample:
Bearer {TokenJWT}Responses
200
Em caso de sucesso
application/json
get
GET /transaction-io/tio-mapper/v1/operations/validacoes/{validacao_id}/documento-fiscal HTTP/1.1
Host: api.int.cerc.com
authorization: Bearer {TokenJWT}
Accept: */*
200
Em caso de sucesso
{
"identificador": {
"numero": "text"
},
"tipo": "text",
"data_da_consulta": "text",
"dados": {
"chave_acesso": "text",
"cobranca": {
"fatura": {
"numero": "text",
"valor_original": "text",
"valor_desconto": "text",
"valor_liquido": "text",
"normalizado_valor_original": 1,
"normalizado_valor_desconto": 1,
"normalizado_valor_liquido": 1
},
"duplicatas": [
{
"numero": "text",
"vencimento": "text",
"normalizado_vencimento": "text",
"valor": "text",
"normalizado_valor": 1
}
]
},
"destinatario": {
"nome": "text",
"endereco": "text",
"bairro": "text",
"cep": "text",
"municipio": "text",
"cod_municipio": 1,
"desc_municipio": "text",
"telefone": "text",
"uf": "text",
"pais": "text",
"cod_pais": 1,
"desc_pais": "text",
"indicador_ie": "text",
"cod_indicador_ie": "text",
"desc_indicador_ie": "text",
"ie": "text",
"suframa": "text",
"im": "text",
"email": "text",
"normalizado_cnpj": "text",
"normalizado_cpf": "text",
"normalizado_cep": "text",
"normalizado_municipio": 1,
"normalizado_telefone": "text",
"normalizado_pais": 1,
"normalizado_indicador_ie": "text",
"document": {
"number": "text",
"type": "text"
},
"abertura_data": "text",
"situacao_cadastral_data": "text",
"situacao_especial_data": "text",
"normalizado_abertura_data": "text",
"normalizado_situacao_cadastral_data": "text",
"normalizado_situacao_especial_data": "text",
"consulta_datahora": "text",
"normalizado_consulta_datahora": "text",
"qsa": "text"
},
"emitente": {
"nome": "text",
"nome_fantasia": "text",
"endereco": "text",
"bairro": "text",
"cep": "text",
"municipio": "text",
"cod_municipio": 1,
"desc_municipio": "text",
"telefone": "text",
"uf": "text",
"pais": "text",
"cod_pais": 1,
"desc_pais": "text",
"ie": "text",
"ie_substituto": "text",
"inscricao_municipal": "text",
"municipio_icms": "text",
"cod_municipio_icms": 1,
"cnae": "text",
"regime": "text",
"cod_regime": 1,
"desc_regime": "text",
"normalizado_cnpj": "text",
"normalizado_cpf": "text",
"normalizado_cep": "text",
"normalizado_municipio": 1,
"normalizado_telefone": "text",
"normalizado_pais": 1,
"normalizado_regime": 1,
"document": {
"number": "text",
"type": "text"
},
"abertura_data": "text",
"situacao_cadastral_data": "text",
"situacao_especial_data": "text",
"normalizado_abertura_data": "text",
"normalizado_situacao_cadastral_data": "text",
"normalizado_situacao_especial_data": "text",
"consulta_datahora": "text",
"normalizado_consulta_datahora": "text",
"qsa": [
"text"
]
},
"info_adicionais": {
"formato_impressao": "text",
"cod_formato_impressao": 1,
"desc_formato_impressao": "text",
"informacoes_fisco": "text",
"informacoes_complementares": "text",
"normalizado_formato_impressao": 1,
"compra": {
"nota_empenho": "text",
"pedido": "text",
"contrato": "text"
}
},
"local": {
"cnpj": "text",
"cpf": "text",
"endereco": "text",
"bairro": "text",
"municipio": "text",
"cod_municipio": "text",
"desc_municipio": "text",
"uf": "text",
"normalizado_cnpj": "text",
"normalizado_cpf": "text",
"normalizado_municipio": "text"
},
"nfe": {
"modelo": "text",
"cod_modelo_documento_fiscal": "text",
"desc_modelo_documento_fiscal": "text",
"serie": "text",
"numero": "text",
"data_emissao": "text",
"normalizado_data_emissao": "text",
"data_saida_entrada": "text",
"normalizado_data_saida_entrada": "text",
"valor_total": "text",
"normalizado_valor_total": 1,
"emitente": {
"nome": "text",
"ie": "text",
"uf": "text",
"normalizado_cnpj": "text",
"document": {
"number": "text",
"type": "text"
},
"abertura_data": "text",
"situacao_cadastral_data": "text",
"situacao_especial_data": "text",
"normalizado_abertura_data": "text",
"normalizado_situacao_cadastral_data": "text",
"normalizado_situacao_especial_data": "text",
"consulta_datahora": "text",
"normalizado_consulta_datahora": "text",
"qsa": [
"text"
]
},
"destinatario": {
"nome": "text",
"ie": "text",
"uf": "text",
"destino_operacao": "text",
"cod_destino_operacao": 1,
"desc_destino_operacao": "text",
"consumidor_final": "text",
"cod_consumidor_final": 1,
"desc_consumidor_final": "text",
"presenca_comprador": "text",
"cod_presenca_comprador": 1,
"desc_presenca_comprador": "text",
"normalizado_cnpj": "text",
"normalizado_cpf": "text",
"normalizado_destino_operacao": 1,
"normalizado_consumidor_final": 1,
"normalizado_presenca_comprador": 1,
"document": {
"number": "text",
"type": "text"
},
"abertura_data": "text",
"situacao_cadastral_data": "text",
"situacao_especial_data": "text",
"normalizado_abertura_data": "text",
"normalizado_situacao_cadastral_data": "text",
"normalizado_situacao_especial_data": "text",
"consulta_datahora": "text",
"normalizado_consulta_datahora": "text",
"qsa": [
"text"
]
},
"emissao": {
"processo": "text",
"cod_processo": "text",
"desc_processo": "text",
"versao": "text",
"tipo": "text",
"cod_tipo": "text",
"desc_tipo": "text",
"finalidade": "text",
"cod_finalidade": "text",
"desc_finalidade": "text",
"natureza_operacao": "text",
"tipo_operacao": "text",
"cod_tipo_operacao": "text",
"desc_tipo_operacao": "text",
"forma_pagamento": "text",
"cod_forma_pagamento": "text",
"desc_forma_pagamento": "text",
"digest": "text",
"normalizado_processo": "text",
"normalizado_tipo": "text",
"normalizado_finalidade": "text",
"normalizado_tipo_operacao": "text",
"normalizado_forma_pagamento": "text"
},
"situacao": "text",
"situacao_ambiente": "text",
"eventos": {
"evento": {
"evento": "text",
"protocolo": "text",
"data_autorizacao": "text",
"normalizado_data_autorizacao": "text",
"data_inclusao": "text",
"normalizado_data_inclusao": "text",
"info": {
"orgao": "text",
"cod_orgao": "text",
"desc_orgao": "text",
"ambiente": "text",
"cod_ambiente": "text",
"desc_ambiente": "text",
"versao": "text",
"chave_acesso": "text",
"id": "text",
"autor": "text",
"data": "text",
"normalizado_data": "text",
"tipo": "text",
"cod_tipo": "text",
"desc_tipo": "text",
"sequencial": "text"
},
"detalhes": {
"descricao": "text",
"versao": "text",
"texto": "text",
"justificativa": "text"
},
"autorizacao_sefaz": {
"mensagem": "text",
"cod_mensagem": "text",
"desc_mensagem": "text",
"protocolo": "text",
"datahora": "text",
"normalizado_datahora": "text"
},
"condicoes_uso": {
"descricao": "text"
}
}
}
},
"normalizado_chave_acesso": "text",
"produtos": {
"produto": {
"num": 1,
"descricao": "text",
"qtd": "text",
"unidade": "text",
"valor": "text",
"normalizado_valor": 1,
"codigo": "text",
"ncm": "text",
"desc_ncm": "text",
"cest": "text",
"ex_tipi": "text",
"cfop": "text",
"desc_cfop": "text",
"outras_despesas": "text",
"normalizado_outras_despesas": 1,
"valor_desconto": "text",
"normalizado_valor_desconto": 1,
"valor_frete": "text",
"normalizado_valor_frete": 1,
"valor_seguro": "text",
"normalizado_valor_seguro": 1,
"composicao_valor": "text",
"cod_composicao_valor": "text",
"desc_composicao_valor": "text",
"ean_comercial": "text",
"unidade_comercial": "text",
"quantidade_comercial": "text",
"normalizado_quantidade_comercial": 1,
"ean_tributavel": "text",
"unidade_tributavel": "text",
"quantidade_tributavel": "text",
"normalizado_quantidade_tributavel": 1,
"valor_unitario_comercial": "text",
"normalizado_valor_unitario_comercial": "text",
"valor_unitario_tributavel": "text",
"normalizado_valor_unitario_tributavel": 1,
"numero_pedido": "text",
"item_pedido": "text",
"tributos": "text",
"normalizado_tributos": 1,
"fci": "text",
"icms": {
"origem_mercadoria": "text",
"cod_origem_mercadoria": 1,
"desc_origem_mercadoria": "text",
"tributacao_icms": "text",
"cod_tributacao_icms": "text",
"desc_tributacao_icms": "text",
"modalidade": "text",
"cod_modalidade": 1,
"desc_modalidade": "text",
"uf": "text"
},
"pis": {
"cst": "text",
"cod_cst": "text",
"desc_cst": "text",
"base_calculo": "text",
"normalizado_base_calculo": 1,
"aliquota": "text",
"normalizado_aliquota": 1,
"valor": "text",
"normalizado_valor": 1
},
"cofins": {
"cst": "text",
"cod_cst": "text",
"desc_cst": "text",
"base_calculo": "text",
"normalizado_base_calculo": 1,
"aliquota": "text",
"normalizado_aliquota": 1,
"valor": "text",
"normalizado_valor": 1
},
"info_adicionais": {},
"especifico_veiculos_novos": {
"tipo_operacao": "text",
"cod_tipo_operacao": "text",
"desc_tipo_operacao": "text",
"chassi": "text",
"cilindradas": "text",
"cor": "text",
"cor_descricao": "text",
"cor_codigo": "text",
"cod_cor": "text",
"desc_cor": "text",
"peso_liquido": "text",
"normalizado_peso_liquido": "text",
"peso_bruto": "text",
"normalizado_peso_bruto": "text",
"serie": "text",
"tipo_combustivel": "text",
"cod_tipo_combustivel": "text",
"desc_tipo_combustivel": "text",
"numero_motor": "text",
"capacidade_maxima_tracao": "text",
"distancia_eixos": "text",
"ano_modelo": "text",
"ano_fabricacao": "text",
"tipo_pintura": "text",
"tipo_veiculo": "text",
"especie": "text",
"cod_especie": "text",
"desc_especie": "text",
"condicao_vin": "text",
"cod_condicao_vin": "text",
"desc_condicao_vin": "text",
"condicao_veiculo": "text",
"cod_condicao_veiculo": "text",
"desc_condicao_veiculo": "text",
"marca_codigo": "text",
"potencia_motor": "text",
"capacidade_passageiros": "text",
"restricao": "text",
"cod_restricao": "text",
"desc_restricao": "text"
},
"especifico_medicamentos": {
"numero_lote": "text",
"quantidade_produtos_no_lote": "text",
"normalizado_quantidade_produtos_no_lote": "text",
"data_fabricacao": "text",
"normlizado_data_fabricacao": "text",
"data_validade": "text",
"normalizado_data_validade": "text",
"preco_maximo_consumidor": "text",
"normalizado_preco_maximo_consumidor": "text"
}
}
},
"totais": {
"base_calculo_icms": "text",
"valor_icms": "text",
"desonerado_icms": "text",
"base_calculo_icms_st": "text",
"valor_icms_st": "text",
"valor_produtos": "text",
"valor_frete": "text",
"valor_seguro": "text",
"outras_despesas": "text",
"valor_ipi": "text",
"valor_nfe": "text",
"valor_descontos": "text",
"valor_ii": "text",
"valor_pis": "text",
"valor_cofins": "text",
"valor_tributos": "text",
"valor_icms_fcp": "text",
"valor_icms_interestadual_dest": "text",
"valor_icms_interestadual_rem": "text",
"normalizado_base_calculo_icms": 1,
"normalizado_valor_icms": 1,
"normalizado_desonerado_icms": 1,
"normalizado_base_calculo_icms_st": 1,
"normalizado_valor_icms_st": 1,
"normalizado_valor_produtos": 1,
"normalizado_valor_frete": 1,
"normalizado_valor_seguro": 1,
"normalizado_outras_despesas": 1,
"normalizado_valor_ipi": 1,
"normalizado_valor_nfe": 1,
"normalizado_valor_descontos": 1,
"normalizado_valor_ii": 1,
"normalizado_valor_pis": 1,
"normalizado_valor_cofins": 1,
"normalizado_valor_tributos": 1,
"normalizado_valor_icms_fcp": 1,
"normalizado_valor_icms_interestadual_dest": 1,
"normalizado_valor_icms_interestadual_rem": 1
},
"transporte": {
"modalidade_frete": "text",
"cod_modalidade_frete": 1,
"desc_modalidade_frete": "text",
"normalizado_modalidade_frete": 1,
"transportador": {
"cnpj": "text",
"nome": "text",
"ie": "text",
"endereco": "text",
"municipio": "text",
"uf": "text",
"normalizado_cnpj": "text"
},
"veiculo": {
"placa": "text",
"uf": "text",
"rntc": "text"
}
}
}
}Path Parameters:
Campo
Obrigatório
Tipo
Descrição
validacao_id
Obrigatório
String
Identificador da Avaliação.
Campo data:
Campo
Formato
data_da_consulta
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.cobranca.duplicatas[].vencimento
DD/MM/YYYY
dados.cobranca.duplicatas[].normalizado_vencimento
YYYY-MM-DDTHH:mm:ss
dados.nfe.data_emissao
Yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.normalizado_data_emissao
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.data_saida_entrada
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.normalizado_data_saida_entrada
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.eventos[0].data_autorizacao
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.eventos[0].normalizado_data_autorizacao
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.eventos[0].data_inclusao
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.eventos[0].normalizado_data_inclusao
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.eventos[0].info.data
yyyy-MM-dd'T'HH:mm:ss-03:00
dados.nfe.eventos[0].info.data
yyyy-MM-dd'T'HH:mm:ss-03:00
Last updated