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:
GERFAT
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:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| Serie | string |
Opcional |
|
| CodigoUnidadeNegocio | string |
Opcional |
|
| UnidadeNegocio |
Opcional |
||
| SerieOficial | string |
Opcional |
|
| Ativo | boolean |
Opcional |
|
| DataCriacao | date |
Opcional |
|
| DataModificacao | date |
Opcional |
Formato de Resposta:
Classe de Resposta (Status 200)
OK
application/json, text/json
Exemplo:
[
{
"Serie": "string 1",
"CodigoUnidadeNegocio": "string 2",
"UnidadeNegocio": {
"Codigo": "string 1",
"Nome": "string 2",
"Fantasia": "string 3",
"CodigoEmpresa": "string 4",
"Empresa": {
"Codigo": "string 1",
"NomeCompleto": "string 2",
"Fantasia": "string 3",
"Endereco": "string 4",
"Numero": "string 5",
"Bairro": "string 6",
"Municipio": "string 7",
"Cidade": {
"NomeMunicipio": "string 1",
"UF": "string 2",
"Codigo": "string 3",
"CodigoGiaEstadual": "string 4",
"CEPInicial": 5,
"CEPFinal": 6,
"CodigoPais": "string 7"
},
"Uf": "string 8",
"Telefone": "string 9",
"Ativo": true,
"Divisao": "string 11",
"CnpjCpf": "string 12",
"Contatos": [
{
"Sequencia": 1,
"CodigoPessoa": "string 2",
"Nome": "string 3",
"Telefone": "string 4",
"Email": "string 5",
"Ramal": "string 6",
"IdProjetoPapel": 7,
"Foto": "string 8"
}
],
"FaxFone": "string 13",
"UsuarioCriacao": "string 14",
"Cep": 1,
"PrefixoCnae": "string 15",
"SufixoCnae": "string 16",
"UnidadeDeNegocio": "string 17",
"Conceito": "string 18",
"Faturamento": 1.1,
"Complemento": "string 19",
"Contato": "string 20",
"Inscricao": "string 21",
"Indicacao": "string 22",
"ContabilCliente": "string 23",
"Responsavel": "string 24",
"ContabilFornecedor": "string 25",
"TipoOperaca": "string 26",
"TipoDeEmpresa": "string 27",
"Atividade": "string 28",
"UsuarioModificacao": "string 29",
"EnviarCarta": "string 30",
"AgendaInterna": "string 31",
"CodigoPais": "string 32",
"Centralizadora": "string 33",
"InscricaoMunicipal": "string 34",
"Suframa": "string 35",
"TipoFrete": "string 36",
"PortadorPadrao": "string 37",
"ContabilAdiantamCliente": "string 38",
"ContabilAdiantamFornecedor": "string 39",
"CentroArmazenagem": "string 40",
"IndiceCredito": "string 41",
"RegiaoEntrega": "string 42",
"Setor": "string 43",
"RegimeTributario": "string 44",
"BaseDoPrazoDiferenciado": "string 45",
"PossuiRetencaoISS": "string 46",
"CentroArmazMatAlternativo": "string 47",
"FiltroDataDIRF": "string 48",
"TipoImovel": "string 49",
"ListarISS": "string 50",
"DiaVencimento": "string 51",
"LimiteFaturado": "string 52",
"GrauDeRelacionamento": "string 53",
"ToleranciaVenciamento": "string 54",
"NivelDeCredito": "string 55",
"Usrempr1": "string 56",
"Usrempr2": "string 57",
"CNAEServico": "string 58",
"ContaEntrada": "string 59",
"AtrasoMedio": 60,
"UtilizaPrazoDiferenciado": 61.1,
"ListarDirf": true,
"Conveniada": true,
"CreditoLiberado": true,
"PercentualFrete": 65.1,
"CodigoEAN": 66.1,
"PercAcrescimoLimite": 67.1,
"TGPadraoParaNFS": 68.1,
"LimiteDeCreditoMensal": 69.1,
"OptantePeloSimples": 70.1,
"Funcionarios": 71,
"Inscrito": true,
"IRRFAcumulado": 73.1,
"LimiteDeCredito": 74.1,
"PercIndenizacao": 75.1,
"PercDescontoSugestaoItens": 76.1,
"PercDesconto2": 77.1,
"JurosPadrao": 78.1,
"PessoaFisica": true,
"Sessao": 80,
"ValorFrete": 81.1,
"Cadastro": "2026-01-13",
"Aniversario": "2026-01-13",
"CodigoTipoPagamento": "string 82",
"CodigoCondicaoPagamento": "string 83",
"CondicaoPagamento": {
"Codigo": "string 1",
"Descricao": "string 2",
"Forma": "string 3",
"Periodicidade": "string 4",
"CodigoFinanceira": "string 5",
"UnidadeNegocio": "string 6",
"CodigoTipoPagamento": "string 7",
"ValidoPara": "string 8",
"ContaSaida": "string 9",
"PercentualDescontoAteVencimento": 10.1,
"PercentualDescontoGeral": 11.1,
"Ativo": true,
"AplicarDescontoPorItem": true,
"PercentualEncargosFinanceiros": 14.1,
"PercentualDescontoSugestaoItens": 15.1,
"PercentualEncargos": 16.1,
"ValorOutrasDespesasAcessorias": 17.1,
"IncluirEncargosFinanceiros": true
},
"CodigoContaSaida": "string 84",
"CodigoRepresentante": "string 85",
"CodigoMercado": "string 86",
"CodigoTabelaPreco": "string 87",
"TabelaPreco": {
"Codigo": "string 1",
"Descricao": "string 2",
"DataValidade": "2026-01-13",
"PrecosTabela": [
{
"CodigoTabela": "string 1",
"Elemento": "string 2",
"PrecoMaior": 3.1,
"PrecoMenor": 4.1,
"PrecoUnitario": 5.1,
"PrecoDesconto": 6.1,
"ValidadeInicial": "2026-01-13",
"ValidadeFinal": "2026-01-13",
"Regra": 7
}
]
},
"PercentualComissaoBaixa": 88.1,
"PercentualAcrescimoPreco": 89.1,
"TabelasPreco": [
{
"TabelaPrecoCodigo": "string 1",
"Tipo": "string 2",
"TipoDescricao": " ",
"CodigoEmpresa": "string 3",
"Divisao": "string 4",
"TabelaPreco": {
"Codigo": "string 1",
"Descricao": "string 2",
"DataValidade": "2026-01-13",
"PrecosTabela": [
{
"CodigoTabela": "string 1",
"Elemento": "string 2",
"PrecoMaior": 3.1,
"PrecoMenor": 4.1,
"PrecoUnitario": 5.1,
"PrecoDesconto": 6.1,
"ValidadeInicial": "2026-01-13",
"ValidadeFinal": "2026-01-13",
"Regra": 7
}
]
}
}
],
"Transportadoras": [
{
"CodigoEmpresa": "string 1",
"CodigoTransportadora": "string 2",
"Sugestao": "string 3",
"TipoFrete": "string 4",
"Ordem": "string 5"
}
],
"Cobrancas": [
{
"CodigoEmpresa": "string 1",
"CodigoCobranca": "string 2",
"Sugestao": "string 3",
"Ordem": "string 4"
}
],
"Observacoes": [
{
"CodigoEmpresa": "string 1",
"Sequencia": 2,
"Observacao": "string 3",
"Tipo": "string 4"
}
],
"ComplementoPessoa": {
"CodigoEmpresa": "string 1",
"Nif": "string 2",
"IdentificacaoSCP": "string 3",
"ContabilClienteLongoPrazo": "string 4",
"BoletoRetencao": true,
"IndicativoNif": "string 6",
"FormaTributacao": "string 7",
"SobreFontePagadora": "string 8",
"CpfProdutorRural": "string 9",
"OrgaoPublico": true,
"TipoAssinanteNfcom": 11,
"MunicipioPrestacao": "string 12"
}
}
},
"SerieOficial": "string 3",
"Ativo": true,
"DataCriacao": "2026-01-13",
"DataModificacao": "2026-01-13"
}
]