Notas de Implementação:
Método para buscar os acompanhanamentos a partir dos dados de filtros passados em formato FiltrosAcompanhamentoDTO.
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
Modelo:
Dados do acompanhamento em formato de DTO
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| TipoAcompanhamento |
Tipo do acompanhamento. Direitos para acesso aos acompanhamentos variam conforme o tipo de acompanhamento. |
string |
Obrigatório Tamanho Único: 1 |
| CodigoEmpresa |
Código de empresa. Obrigatório quando o tipo de acompanhamento for Embarque ("E"), Empresa (" "), Evento ("Y"), Frota ("U"), Cotação ("4"), Cronograma Pedido ("1"), Curso ("Z"), Viagem ("B"), Item OC ("9"), Item Pedido ("I"), Item Pré Nota ("2"), Lançamento ("F"), Modalidade Pagamento ("M"), NF ("N"), NF Entrada ("D"), OC ("O"), Oportunidade ("C"), OS ("S"), Pedido ("P"), Pré Nota ("0"), Processo Documento ("K"), Protocolo ("L"), Tabela Preço ("T"), Workflow ("W") |
string |
Obrigatório |
| EmbarquePedidoOc |
Embarque / Pedido / Ordem de compra. Obrigatório quando o tipo de acompanhamento for Curso ("Z"), Emissão Inventário ("6"), Embarque ("E"), Evento ("Y"), Frota ("U"), Gestão Projeto ("G"), Item OC ("9"), Item Pedido ("I"), Modalidade Pagamento ("M"), NF Entrada ("D"), OC ("O"), Ordem Desmontagem ("+"), Ordem Produção ("$"), Pedido ("P"), Requisição/Solicitação ("R"), Tabela Preço ("T") |
string |
Obrigatório |
| ContatoOsLancNf |
Contato / Ordem de serviço / Lançamento / Nota fiscal. Obrigatório quando o tipo de acompanhamento for Agronegócio ("Q"), Cotação ("4"), Configuração ("H"), Gestão Projeto ("G"), Item Pré Nota ("2"), Lançamento ("F"), Material ("7"), NF ("N"), NF Entrada ("D"), Oportunidade ("C"), OS ("S"), Pré Nota ("0"), Processo Documento ("K"), Protocolo ("L"), Transferência Saldo Contrato ("J"), Viagem ("B"), Workflow ("W") |
decimal number |
Obrigatório |
| SequenciaItem |
Sequência do item a ser filtrado. Obrigatório quando o tipo de acompanhamento for Cotação ("4"), Emissão Inventário ("6"), Frota ("U"), Item OC ("9"), Item Pedido ("I"), Item Pré Nota ("2"), OS ("S") |
integer |
Obrigatório |
| Remessas |
Remessa a ser filtrada. Opcional quando o tipo de acompanhamento for Gestão Projeto ("G") |
string |
Obrigatório |
Formato de Envio:
application/json, text/json
Exemplo:
{
"TipoAcompanhamento": "string 1",
"CodigoEmpresa": "string 2",
"EmbarquePedidoOc": "string 3",
"ContatoOsLancNf": 4.0,
"SequenciaItem": 5,
"Remessas": "string 6"
}
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 |
|---|---|---|---|
| Codigo | decimal number |
Opcional |
|
| CodigoEmpresa | string |
Opcional |
|
| CodigoOrdemServico | decimal number |
Opcional |
|
| CodigoItem | integer |
Opcional |
|
| TipoAcompanhamento | string |
Opcional |
|
| CodigoTitulo | string |
Opcional |
|
| Para | string |
Opcional |
|
| Cc | string |
Opcional |
|
| Anexos | string |
Opcional |
|
| Historico | string |
Opcional |
|
| Assunto | string |
Opcional |
|
| SequenciaContato | integer |
Opcional |
|
| Usuario | string |
Opcional |
|
| UsuarioCriacao | string |
Opcional |
|
| Contatante | string |
Opcional |
|
| Data | date |
Opcional |
|
| Hora | string |
Opcional |
|
| DataCriacao | date |
Opcional |
|
| Aprovado | boolean |
Opcional |
|
| Campo40 | boolean |
Opcional |
|
| Campo41 | boolean |
Opcional |
|
| AcompanhamentoRestrito | string |
Opcional |
|
| Revisado | string |
Opcional |
|
| SituacaoTipoMaterial | string |
Opcional |
|
| EmbarquePedidoOC | string |
Opcional |
|
| Remessas | string |
Opcional |
|
| Controle | string |
Opcional |
|
| ControleAnterior | string |
Opcional |
|
| SituacaoAnterior | string |
Opcional |
|
| UsuarioModificacao | string |
Opcional |
|
| Grupo | string |
Opcional |
|
| SubGrupo | string |
Opcional |
|
| Contato | string |
Opcional |
|
| UsuarioAlteracaoControle | string |
Opcional |
|
| Campo36 | string |
Opcional |
|
| Campo37 | string |
Opcional |
|
| ValorPotencial | decimal number |
Opcional |
|
| Campo19 | decimal number |
Opcional |
|
| Campo20 | decimal number |
Opcional |
|
| Campo21 | decimal number |
Opcional |
|
| Campo22 | decimal number |
Opcional |
|
| Campo23 | decimal number |
Opcional |
|
| Campo24 | decimal number |
Opcional |
|
| Campo25 | decimal number |
Opcional |
|
| HoraCriacao | integer |
Opcional |
|
| LinkGerenciadorDoc | string |
Opcional |
|
| TextoGerenciadorDoc | string |
Opcional |
|
| DataPrevista | date |
Opcional |
|
| HoraPrevista | string |
Opcional |
|
| DataRealizada | date |
Opcional |
|
| HoraRealizada | string |
Opcional |
|
| UsuarioDados |
Opcional |
||
| Titulo |
Opcional |
||
| EmpresaContatante |
Opcional |
Formato de Resposta:
Classe de Resposta (Status 200)
Retorna os dados referentes aos acompanhamentos encontrados.
application/json, text/json
Exemplo:
[
{
"Codigo": 1.0,
"CodigoEmpresa": "string 2",
"CodigoOrdemServico": 3.0,
"CodigoItem": 4,
"TipoAcompanhamento": "string 5",
"CodigoTitulo": "string 6",
"Para": "string 7",
"Cc": "string 8",
"Anexos": "string 9",
"Historico": "string 10",
"Assunto": "string 11",
"SequenciaContato": 12,
"Usuario": "string 13",
"UsuarioCriacao": "string 14",
"Contatante": "string 15",
"Data": "2026-01-13",
"Hora": "string 16",
"DataCriacao": "2026-01-13",
"Aprovado": true,
"Campo40": true,
"Campo41": true,
"AcompanhamentoRestrito": "string 20",
"Revisado": "string 21",
"SituacaoTipoMaterial": "string 22",
"EmbarquePedidoOC": "string 23",
"Remessas": "string 24",
"Controle": "string 25",
"ControleAnterior": "string 26",
"SituacaoAnterior": "string 27",
"UsuarioModificacao": "string 28",
"Grupo": "string 29",
"SubGrupo": "string 30",
"Contato": "string 31",
"UsuarioAlteracaoControle": "string 32",
"Campo36": "string 33",
"Campo37": "string 34",
"ValorPotencial": 35.1,
"Campo19": 36.1,
"Campo20": 37.1,
"Campo21": 38.1,
"Campo22": 39.1,
"Campo23": 40.1,
"Campo24": 41.1,
"Campo25": 42.1,
"HoraCriacao": 43,
"LinkGerenciadorDoc": "string 44",
"TextoGerenciadorDoc": "string 45",
"DataPrevista": "2026-01-13",
"HoraPrevista": "string 46",
"DataRealizada": "2026-01-13",
"HoraRealizada": "string 47",
"UsuarioDados": {
"Codigo": "string 1",
"NomeUsuario": "string 2",
"Login": "string 2",
"Nome": "string 3",
"Senha": "string 4",
"Empresa": "string 5",
"Email": "string 6",
"ImagemTemp": "string 7",
"ImagemPersonalizada": "string 8",
"Pessoa": {
"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"
}
}
},
"Titulo": {
"CodigoTitulo": "string 1",
"DescricaoTitulo": "string 2"
},
"EmpresaContatante": {
"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"
}
}
}
]