Notas de Implementação:
Esse método suporta a passagem de parâmetros de consultas OData para restringir os resultados. Mais informações em: https://learn.microsoft.com/pt-br/odata/overview
Informações de Envio:
Cabeçalhos de Envio:
| Parâmetro | Valor | Descrição | Tipo de parâmetro | Tipo de dados |
|---|---|---|---|---|
| Authorization | Bearer | Hash gerado no login | Header | String |
Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar
Direitos:
FANFISCA_P
Parâmetros URL:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| codigoNota |
Código numerico (long) da nota fiscal a ser pesquisada |
integer |
Obrigatório |
| codigoUnidadeNegocio |
Código (string) da unidade de negócio da nota |
string |
Obrigatório |
| codigoPedido | string |
Obrigatório |
|
| codigoSerie | string |
Obrigatório |
Informações de Retorno:
Cabeçalhos Adicionais:
| Nome | Descrição | Valor |
|---|---|---|
| cigam-api-version | Versão do build/compilação dessa versão da API | 2.1.8565.21067 |
Modelo:
Objeto JSON com a Model NotaFiscal
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| NF | integer |
Opcional |
|
| CodigoSerie | string |
Opcional |
|
| CodigoUnidadeNegocio | string |
Opcional |
|
| CodigoTipoOperacao | string |
Opcional |
|
| DescricaoTipoOperacao | string |
Opcional |
|
| CodigoTransportadora | string |
Opcional |
|
| TipoNota | string |
Opcional |
|
| TipoNotaDescricao | string |
Opcional |
|
| TotalMercadoria | decimal number |
Opcional |
|
| TotalNF | decimal number |
Opcional |
|
| TotalFaturado | decimal number |
Opcional |
|
| CodigoPedido | string |
Opcional |
|
| TipoFrete | string |
Opcional |
|
| Placa | string |
Opcional |
|
| DataEmissao | date |
Opcional |
|
| DataSaida | date |
Opcional |
|
| HoraSaida | string |
Opcional |
|
| CodigoCliente | string |
Opcional |
Formato de Resposta:
Classe de Resposta (Status 200)
OK
application/json, text/json
Exemplo:
{
"NF": 1,
"CodigoSerie": "string 2",
"CodigoUnidadeNegocio": "string 3",
"CodigoTipoOperacao": "string 4",
"DescricaoTipoOperacao": "string 5",
"CodigoTransportadora": "string 6",
"TipoNota": "string 7",
"TipoNotaDescricao": " ",
"TotalMercadoria": 8.1,
"TotalNF": 9.1,
"TotalFaturado": 10.1,
"CodigoPedido": "string 11",
"TipoFrete": "string 12",
"Placa": "string 13",
"DataEmissao": "2026-04-14",
"DataSaida": "2026-04-14",
"HoraSaida": "string 14",
"CodigoCliente": "string 15"
}