Central do Uniplus

Índice
< Todo o conteúdo
Imprimir

API Consulta de ordens de serviço (WEB)

Foi criado o endpoint para listar as ordens de serviço. O link fica em “/public-api/v1/ordem-servico” e será suportado o método “GET”.


 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

IdentificadorDescriçãoObrigatórioTipoTamanhoDecimaisObservações
idIDInteiro
codigoCódigoCaractere20
idClienteID do clienteInteiro
codigoClienteCódigo ClienteCaractere14
nomeClienteNome ClienteCaractere60
cnpjCpfClienteCNPJ ou CPF do ClienteCaractere18
dataOrdemServicoData da Ordem de ServiçoData
dataData/HoraData/Hora19
idFilialID da FilialInteiro
codigoFilialCódigo da FilialCaractere4
descricaoItemDescrição do ItemCaractere200
problemaDescritoProblema DescritoCaractere200
idAtendenteID do AtendenteInteiro
nomeAtendenteNome do AtendenteCaractere60
statusStatusInteiro1 – 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;
valorValorNumérico122
valorProdutosValor dos ProdutosNumérico122
valorServicosValor dos ServiçosNumérico122
descricaoTipoUltimoEventoDescrição Tipo “Último Evento”Caractere200
descricaoUltomEventoCaractere200
extra1Extra 1Caractere200
extra2Extra 2Caractere200
extra3Extra 3Caractere200
extra4Extra 4Caractere200
extra5Extra 5Caractere200
extra6Extra 6Caractere200
extra7Extra 7Caractere200
extra8Extra 8Caractere200
extra9Extra 9Caractere200
extra10Extra 10Caractere200
extra11Extra 11Caractere200
extra12Extra 12Caractere200
extra13Extra 13Caractere200
extra14Extra 14Caractere200
extra15Extra 15Caractere200
extra16Extra 16Caractere200
currentTimeMillisInteiro
itensLista de itens

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

IdentificadorDescriçãoObrigatórioTipoTamanhoDecimaisObservações
idIDInteiro
idOrdemServicoID da Ordem de ServiçoInteiro
contadorContadorInteiro
idProdutoID do ProdutoInteiro
codigoProdutoCódigo do ProdutoCaractere20
nomeProdutoNome do ProdutoCaractere120
unidadeMedidaUnidade de MedidaCaractere6
quantidadeQuantidadeNumérico156
precoPreçoNumérico156
descontoDescontoNumérico12
totalTotalNumérico123
observacaoObservaçãoCaractere200
idTecnicoID do TécnicoInteiro
nomeTecnicoNome do TécnicoCaractere60
numeroSerieNúmero de SérieCaractere40

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

15 Artigos recentes

Ver os últimos 100