Ordens de serviço por período
Ordens de serviço abertas no período (itens, receita óptica, cliente, funcionário, formas de pagamento), incluindo os valores financeiros `adiantamento`, `valor_a_receber`, `valor_credito_troca` e `valor_liquido_menos_troca`. Paginação opt-in (`page`/`perPage`). Intervalo máximo de 180 dias. Por padrão retorna apenas O.S. **ativas** (exclui `PERDA` e `CANCELADO`); use o parâmetro `status` para incluir outros status.
Authorization
userToken Token de usuário do ssOtica, obtido na tela de perfil do sistema. Enviado como
Authorization: Bearer {token}.
In: header
Query Parameters
CNPJ/CPF da empresa (com ou sem máscara). Informe cnpj e/ou empresa.
Chave de contrato da empresa. Informe cnpj e/ou empresa.
Início do período (YYYY-MM-DD).
Fim do período (YYYY-MM-DD).
Lista de status separada por vírgula. Sem o parâmetro, retorna só O.S. ativas
(exclui PERDA/CANCELADO). Use TODAS para todos os status. Valores aceitos:
ABERTO, CANCELADO, FECHADO, PERDA, VENDIDO, VELADO, ENTREGUE. Valor
inválido retorna 400 com error: PARAMETRO_INVALIDO.
Página.
Itens por página, 1–100 (nos endpoints de período, ativa a paginação).
Se presente, a resposta é retornada como JSONP.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/integracoes/ordens-servico/periodo?inicio_periodo=2026-06-01&fim_periodo=2026-06-30"[ { "id": 305, "numero": "305", "tipo_os": "Óculos de grau", "etapa_atual": "Em produção", "status": "ABERTO", "data": "2026-01-18", "previsao_entrega": "2026-01-25", "data_entrega": "", "valor_bruto": 500, "acrescimo": 0, "desconto": 50, "valor_liquido": 450, "adiantamento": 200, "valor_a_receber": 250, "valor_credito_troca": 0, "valor_liquido_menos_troca": 450, "receita": {}, "funcionario": {}, "itens": [ {} ], "formas_pagamento": [ {} ], "cliente": {}, "origensCliente": [ "string" ] }]{ "error": "DATA_INVALIDA", "error_info": "O campo \"inicio_periodo\" contém uma data inválida. Utilize o formato AAAA-MM-DD (ex.: 2026-06-30)."}{ "error": "Unauthenticated."}