Endpoint Consulta de ordens de serviço (v1)

---

Descrição geral

Listagem de ordens de serviços

---

URL

“/public-api/v1/ordem-servico“

---

Verbos suportados

GET

---

Status HTTP

200 = OK, 422  =  A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

---

 JSON Exemplo

[    
    {
        "identificacao": "OS",
        "tabela": "ordemservico",
        "descricaoLayout": "Ordem de serviço",
        "id": 11,
        "codigo": 10,
        "idCliente": 2583,
        "codigoCliente": "139",
        "nomeCliente": "10 - LUCAS MARTINS MENDES",
        "cnpjCpfCliente": "077.977.281-43",
        "dataOrdemServico": "2023-05-31",
        "data": "2023-05-31T16:28:00",
        "idFilial": 1,
        "codigoFilial": "1",
        "descricaoItem": "Teste",
        "problemaDescrito": "Teste",
        "idAtendente": 76,
        "nomeAtendente": "Técnico 01",
        "status": 1,
        "valor": "185.00",
        "valorProdutos": "0.00",
        "valorServicos": "185.00",
        "descricaoTipoUltimoEvento": "",
        "descricaoUltomEvento": "",
        "extra1": "",
        "extra2": "",
        "extra3": "",
        "extra4": "",
        "extra5": "",
        "extra6": "",
        "extra7": "",
        "extra8": "",
        "extra9": "",
        "extra10": "",
        "extra11": "",
        "extra12": "",
        "extra13": "",
        "extra14": "",
        "extra15": "",
        "extra16": "",
        "currentTimeMillis": 1685562145678,
        "itens": [
            {
                "identificacao": "OSI",
                "tabela": "ordemservicoitem",
                "descricaoLayout": "Ordem de serviço - itens",
                "id": 21,
                "idOrdemServico": 11,
                "contador": 2,
                "idProduto": 60,
                "codigoProduto": "1021",
                "nomeProduto": "Serviço não tributado",
                "unidadeMedida": "HR",
                "quantidade": "1.000000",
                "preco": "50.000000",
                "desconto": "0.00",
                "total": "50.000",
                "observacao": "sim",
                "idTecnico": 76,
                "nomeTecnico": "Técnico 01",
                "numeroSerie": ""
            },
            {
                "identificacao": "OSI",
                "tabela": "ordemservicoitem",
                "descricaoLayout": "Ordem de serviço - itens",
                "id": 20,
                "idOrdemServico": 11,
                "contador": 1,
                "idProduto": 59,
                "codigoProduto": "1020",
                "nomeProduto": "Serviço substituição tributaria",
                "unidadeMedida": "UN",
                "quantidade": "3.000000",
                "preco": "50.000000",
                "desconto": "15.00",
                "total": "135.000",
                "observacao": "tem",
                "idTecnico": 76,
                "nomeTecnico": "Técnico 01",
                "numeroSerie": ""
            }
        ]
    }
]

---

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/ordem-servico/${codigo}”

---

Lista dos campos do JSON da ordem de serviço

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
codigo	Código		Caractere	20
idCliente	ID do cliente		Inteiro
codigoCliente	Código Cliente		Caractere	14
nomeCliente	Nome Cliente		Caractere	60
cnpjCpfCliente	CNPJ ou CPF do Cliente		Caractere	18
dataOrdemServico	Data da Ordem de Serviço		Data
data	Data/Hora		Data/Hora	19
idFilial	ID da Filial		Inteiro
codigoFilial	Código da Filial		Caractere	4
descricaoItem	Descrição do Item		Caractere	200
problemaDescrito	Problema Descrito		Caractere	200
idAtendente	ID do Atendente		Inteiro
nomeAtendente	Nome do Atendente		Caractere	60
status	Status		Inteiro			1 – Aberta; 2 – Em execução; 3 – Finalizada; 4 – Cancelada; 5 – Faturada; 6 – Agendada; 7 – Pausada; 8 – Passou pelo PDV; 9 – Faturada por DAV OS; 10 – Mesclado; 11 – Duplicado; 12 – Serviço não executado; 13 – Orçamento; 14 – Faturado parcialmente; 15 – Retirada;
valor	Valor		Numérico	12	2
valorProdutos	Valor dos Produtos		Numérico	12	2
valorServicos	Valor dos Serviços		Numérico	12	2
descricaoTipoUltimoEvento	Descrição Tipo “Último Evento”		Caractere	200
descricaoUltomEvento			Caractere	200
extra1	Extra 1		Caractere	200
extra2	Extra 2		Caractere	200
extra3	Extra 3		Caractere	200
extra4	Extra 4		Caractere	200
extra5	Extra 5		Caractere	200
extra6	Extra 6		Caractere	200
extra7	Extra 7		Caractere	200
extra8	Extra 8		Caractere	200
extra9	Extra 9		Caractere	200
extra10	Extra 10		Caractere	200
extra11	Extra 11		Caractere	200
extra12	Extra 12		Caractere	200
extra13	Extra 13		Caractere	200
extra14	Extra 14		Caractere	200
extra15	Extra 15		Caractere	200
extra16	Extra 16		Caractere	200
currentTimeMillis			Inteiro
itens			Lista de itens

---

Lista dos campos do JSON dos itens da Ordem de Serviço

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
id	ID		Inteiro
idOrdemServico	ID da Ordem de Serviço		Inteiro
contador	Contador		Inteiro
idProduto	ID do Produto		Inteiro
codigoProduto	Código do Produto		Caractere	20
nomeProduto	Nome do Produto		Caractere	120
unidadeMedida	Unidade de Medida		Caractere	6
quantidade	Quantidade		Numérico	15	6
preco	Preço		Numérico	15	6
desconto	Desconto		Numérico	12
total	Total		Numérico	12	3
observacao	Observação		Caractere	200
idTecnico	ID do Técnico		Inteiro
nomeTecnico	Nome do Técnico		Caractere	60
numeroSerie	Número de Série		Caractere	40

Conteúdo Relacionado

Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda