Notas de Implementação:
Busca os dados da OS
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:
SC945HG210,MNSCMOV,GMOSERV_P,GM226OUR87,MNGMMOV
Itens de Menu:
GS01519,AY00081,GS01546
Parâmetros URL:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| os |
Ordem de serviço do cliente |
integer |
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:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| CodigoOrdemServico | integer |
Opcional |
|
| Item | integer |
Opcional |
|
| CodigoTipoOrdemServico | string |
Opcional |
|
| DescricaoTipoOrdemServico | string |
Opcional |
|
| Situacao | string |
Opcional |
|
| CodigoEquipe | string |
Opcional |
|
| DescricaoEquipe | string |
Opcional |
|
| DataItem | date |
Opcional |
|
| PrazoProgramado | date |
Opcional |
|
| PrazoSolicitado | date |
Opcional |
|
| DataConclusao | date |
Opcional |
|
| UltimoAtendimento | date |
Opcional |
|
| Orcamento | string |
Opcional |
|
| Local | string |
Opcional |
|
| CodigoProduto | string |
Opcional |
|
| DescricaoProduto | string |
Opcional |
|
| CodigoReclamante | string |
Opcional |
|
| FantasiaReclamante | string |
Opcional |
|
| Contato | string |
Opcional |
|
| Assunto | string |
Opcional |
|
| Projeto | string |
Opcional |
|
| CodigoSolicitado | string |
Opcional |
|
| DescricaoSolicitado | string |
Opcional |
|
| DescricaoReclamado | string |
Opcional |
|
| CodigoCausa | string |
Opcional |
|
| DescricaoCodigoCausa | string |
Opcional |
|
| DescricaoCausa | string |
Opcional |
|
| CodigoPrioridade | string |
Opcional |
|
| Versao | string |
Opcional |
|
| CodigoSolucao | string |
Opcional |
|
| DescricaoCodigoSolucao | string |
Opcional |
|
| DescricaoSolucao | string |
Opcional |
|
| CodigoCliente | string |
Opcional |
|
| CodigoRepresentante | string |
Opcional |
|
| FantasiaCliente | string |
Opcional |
|
| OrdemServicoTerceiro | string |
Opcional |
|
| Observacao | string |
Opcional |
|
| CodigoProjeto | decimal number |
Opcional |
|
| DescricaoProjeto | string |
Opcional |
|
| Cliente |
Opcional |
||
| Representante |
Opcional |
Formato de Resposta:
Classe de Resposta (Status 200)
Objeto JSON com dados da OS
application/json, text/json
Exemplo:
[
{
"CodigoOrdemServico": 1,
"Item": 2,
"CodigoTipoOrdemServico": "string 3",
"DescricaoTipoOrdemServico": "string 4",
"Situacao": "string 5",
"CodigoEquipe": "string 6",
"DescricaoEquipe": "string 7",
"DataItem": "2026-04-14",
"PrazoProgramado": "2026-04-14",
"PrazoSolicitado": "2026-04-14",
"DataConclusao": "2026-04-14",
"UltimoAtendimento": "2026-04-14",
"Orcamento": "string 8",
"Local": "string 9",
"CodigoProduto": "string 10",
"DescricaoProduto": "string 11",
"CodigoReclamante": "string 12",
"FantasiaReclamante": "string 13",
"Contato": "string 14",
"Assunto": "string 15",
"Projeto": "string 16",
"CodigoSolicitado": "string 17",
"DescricaoSolicitado": "string 18",
"DescricaoReclamado": "string 19",
"CodigoCausa": "string 20",
"DescricaoCodigoCausa": "string 21",
"DescricaoCausa": "string 22",
"CodigoPrioridade": "string 23",
"Versao": "string 24",
"CodigoSolucao": "string 25",
"DescricaoCodigoSolucao": "string 26",
"DescricaoSolucao": "string 27",
"CodigoCliente": "string 28",
"CodigoRepresentante": "string 29",
"FantasiaCliente": "string 30",
"OrdemServicoTerceiro": "string 31",
"Observacao": "string 32",
"CodigoProjeto": 33.1,
"DescricaoProjeto": "string 34",
"Cliente": {
"Codigo": "string 1",
"NomeCompleto": "string 2",
"CnpjCpf": "string 3",
"Uf": "string 4",
"UsuarioCriacao": "string 5",
"Inscricao": "string 6",
"PessoaFisica": true,
"Fantasia": "string 8",
"Endereco": "string 9",
"Numero": "string 10",
"Bairro": "string 11",
"Municipio": "string 12",
"Telefone": "string 13",
"Ativo": true,
"Divisao": "string 15",
"FaxFone": "string 16",
"Cep": "string 17",
"Aniversario": "2026-04-14",
"Faturamento": 1.1,
"CodigoPais": "string 18",
"Complemento": "string 19",
"Cnae": "string 20",
"Contato": "string 21",
"Conceito": "string 22",
"Cadastro": "2026-04-14",
"CodigoRepresentante": "string 23",
"PercentualComissaoBaixa": 24.1,
"ContabilCliente": "string 25",
"Responsavel": "string 26",
"Indicacao": "string 27",
"ContabilFornecedor": "string 28",
"CodigoCondicaoPagamento": "string 29",
"CodigoTipoPagamento": "string 30",
"Inscrito": true,
"IrrfAcumulado": 32.1,
"TipoEmpresa": "string 33",
"Atividade": "string 34",
"Funcionarios": 35,
"LimiteCredito": 36.1,
"CodigoMercado": "string 37",
"EnviarCarta": "string 38",
"CodigoTabelaPreco": "string 39",
"AgendaInterna": "string 40",
"Centralizadora": "string 41",
"AtrasoMedio": 42,
"InscricaoMunicipal": "string 43",
"Suframa": "string 44",
"TipoFrete": "string 45",
"PercentualIndenizacao": 46.1,
"PercentualDescontoSugestaoItens": 47.1,
"PercentualDesconto2": 48.1,
"JurosPadrao": 49.1,
"UnidadeNegocio": "string 50",
"PortadorPadrao": "string 51",
"ContabilAdiantamentoCliente": "string 52",
"ContabilAdiantamentoFornecedor": "string 53",
"CentroArmazenagem": "string 54",
"IndiceCredito": "string 55",
"RegiaoEntrega": "string 56",
"RegimeTributario": "string 57",
"Setor": "string 58",
"PrefixoCnae": "string 59",
"BasePrazoDiferenciado": "string 60",
"PossuiRetencaoIss": "string 61",
"CentroArmazenagemMaterialAlternativo": "string 62",
"FiltroDataDirf": "string 63",
"TipoImovel": "string 64",
"ListarIss": "string 65",
"DiaVencimento": "string 66",
"LimiteFaturado": "string 67",
"GrauRelacionamento": "string 68",
"SufixoCnae": "string 69",
"ToleranciaVencimento": "string 70",
"NivelCredito": "string 71",
"ListarDirf": true,
"Conveniada": true,
"CreditoLiberado": true,
"PercentualFrete": 75.1,
"CodigoEan": 76.1,
"PercentualAcrescimoLimite": 77.1,
"PercentualAcrescimoPreco": 78.1,
"UtilizaPrazoDiferenciado": 79.1,
"TgPadraoNfs": 80.1,
"LimiteCreditoMensal": 81.1,
"OptantePeloSimples": 82.1,
"Usrempr1": "string 83",
"Usrempr2": "string 84",
"CnaeServico": "string 85",
"ValorFrete": 86.1,
"TipoOperacao": "string 87",
"Email": "string 88",
"OpcoesAuxiliares": "string 89",
"NotificacaoBloquetoEmail": "string 90",
"RecebeEmailCartaCobranca": "string 91",
"CodigoIbge": "string 92",
"ValidarIbgeInformado": true,
"UsaMaiusculaMunicipio": true,
"PermiteCriarComErro": true,
"PermiteSobrescreverComBranco": true,
"Latitude": 97.1,
"Longitude": 98.1,
"Nif": "string 99",
"IdentificacaoSCP": "string 100",
"ContabilClienteLongoPrazo": "string 101",
"BoletoRetencao": "string 102",
"IndicativoNif": "string 103",
"FormaTributacao": "string 104",
"SobreFontePagadora": "string 105",
"CpfProdutorRural": "string 106",
"OrgaoPublico": true,
"TipoAssinanteNfcom": 108,
"MunicipioPrestacao": "string 109"
},
"Representante": {
"Codigo": "string 1",
"NomeCompleto": "string 2",
"CnpjCpf": "string 3",
"Uf": "string 4",
"UsuarioCriacao": "string 5",
"Inscricao": "string 6",
"PessoaFisica": true,
"Fantasia": "string 8",
"Endereco": "string 9",
"Numero": "string 10",
"Bairro": "string 11",
"Municipio": "string 12",
"Telefone": "string 13",
"Ativo": true,
"Divisao": "string 15",
"FaxFone": "string 16",
"Cep": "string 17",
"Aniversario": "2026-04-14",
"Faturamento": 1.1,
"CodigoPais": "string 18",
"Complemento": "string 19",
"Cnae": "string 20",
"Contato": "string 21",
"Conceito": "string 22",
"Cadastro": "2026-04-14",
"CodigoRepresentante": "string 23",
"PercentualComissaoBaixa": 24.1,
"ContabilCliente": "string 25",
"Responsavel": "string 26",
"Indicacao": "string 27",
"ContabilFornecedor": "string 28",
"CodigoCondicaoPagamento": "string 29",
"CodigoTipoPagamento": "string 30",
"Inscrito": true,
"IrrfAcumulado": 32.1,
"TipoEmpresa": "string 33",
"Atividade": "string 34",
"Funcionarios": 35,
"LimiteCredito": 36.1,
"CodigoMercado": "string 37",
"EnviarCarta": "string 38",
"CodigoTabelaPreco": "string 39",
"AgendaInterna": "string 40",
"Centralizadora": "string 41",
"AtrasoMedio": 42,
"InscricaoMunicipal": "string 43",
"Suframa": "string 44",
"TipoFrete": "string 45",
"PercentualIndenizacao": 46.1,
"PercentualDescontoSugestaoItens": 47.1,
"PercentualDesconto2": 48.1,
"JurosPadrao": 49.1,
"UnidadeNegocio": "string 50",
"PortadorPadrao": "string 51",
"ContabilAdiantamentoCliente": "string 52",
"ContabilAdiantamentoFornecedor": "string 53",
"CentroArmazenagem": "string 54",
"IndiceCredito": "string 55",
"RegiaoEntrega": "string 56",
"RegimeTributario": "string 57",
"Setor": "string 58",
"PrefixoCnae": "string 59",
"BasePrazoDiferenciado": "string 60",
"PossuiRetencaoIss": "string 61",
"CentroArmazenagemMaterialAlternativo": "string 62",
"FiltroDataDirf": "string 63",
"TipoImovel": "string 64",
"ListarIss": "string 65",
"DiaVencimento": "string 66",
"LimiteFaturado": "string 67",
"GrauRelacionamento": "string 68",
"SufixoCnae": "string 69",
"ToleranciaVencimento": "string 70",
"NivelCredito": "string 71",
"ListarDirf": true,
"Conveniada": true,
"CreditoLiberado": true,
"PercentualFrete": 75.1,
"CodigoEan": 76.1,
"PercentualAcrescimoLimite": 77.1,
"PercentualAcrescimoPreco": 78.1,
"UtilizaPrazoDiferenciado": 79.1,
"TgPadraoNfs": 80.1,
"LimiteCreditoMensal": 81.1,
"OptantePeloSimples": 82.1,
"Usrempr1": "string 83",
"Usrempr2": "string 84",
"CnaeServico": "string 85",
"ValorFrete": 86.1,
"TipoOperacao": "string 87",
"Email": "string 88",
"OpcoesAuxiliares": "string 89",
"NotificacaoBloquetoEmail": "string 90",
"RecebeEmailCartaCobranca": "string 91",
"CodigoIbge": "string 92",
"ValidarIbgeInformado": true,
"UsaMaiusculaMunicipio": true,
"PermiteCriarComErro": true,
"PermiteSobrescreverComBranco": true,
"Latitude": 97.1,
"Longitude": 98.1,
"Nif": "string 99",
"IdentificacaoSCP": "string 100",
"ContabilClienteLongoPrazo": "string 101",
"BoletoRetencao": "string 102",
"IndicativoNif": "string 103",
"FormaTributacao": "string 104",
"SobreFontePagadora": "string 105",
"CpfProdutorRural": "string 106",
"OrgaoPublico": true,
"TipoAssinanteNfcom": 108,
"MunicipioPrestacao": "string 109"
}
}
]