{"openapi":"3.0.3","info":{"title":"Lymos ERP - API de integra\u00e7\u00e3o (somente leitura)","version":"1.0.0","description":"Consulta produtos, clientes, pedidos e notas de servi\u00e7o da empresa dona do token. O token \u00e9 gerado pela empresa em Configura\u00e7\u00f5es > Integra\u00e7\u00f5es e enxerga somente os dados dela. Escopos: produtos:ler, clientes:ler, pedidos:ler, nfse:ler. Datas: AAAA-MM-DD ou ISO 8601. Limite: 120 requisi\u00e7\u00f5es por minuto por token. Documenta\u00e7\u00e3o para pessoas: https:\/\/app.lymos.com.br\/api\/v1\/integracao\/docs"},"servers":[{"url":"https:\/\/app.lymos.com.br\/api\/v1\/integracao"}],"paths":{"\/perfil":{"get":{"summary":"Teste de conex\u00e3o: empresa do token, escopos e recursos dispon\u00edveis","operationId":"perfil","security":[{"token":[]}],"responses":{"200":{"description":"Dados em {data}."},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/produtos":{"get":{"summary":"Lista produtos com pre\u00e7o e estoque dispon\u00edvel","description":"Exige o escopo produtos:ler.","operationId":"listar_produtos","security":[{"token":[]}],"parameters":[{"name":"busca","in":"query","required":false,"description":"Nome, SKU ou c\u00f3digo de barras (parcial).","schema":{"type":"string"}},{"name":"ativo","in":"query","required":false,"description":"1 (padr\u00e3o) s\u00f3 ativos; 0 s\u00f3 inativos.","schema":{"type":"string"}},{"name":"atualizado_desde","in":"query","required":false,"description":"Data\/hora ISO 8601: s\u00f3 o que mudou desde ent\u00e3o (sincroniza\u00e7\u00e3o incremental).","schema":{"type":"string"}},{"name":"pagina","in":"query","required":false,"description":"P\u00e1gina (come\u00e7a em 1).","schema":{"type":"integer"}},{"name":"por_pagina","in":"query","required":false,"description":"Itens por p\u00e1gina (1 a 100, padr\u00e3o 25).","schema":{"type":"integer"}}],"responses":{"200":{"description":"Lista paginada: {data: [...], meta: {pagina, por_pagina, total, ultima_pagina}}.","content":{"application\/json":{"example":{"data":[{"id":812,"nome":"Camiseta b\u00e1sica preta M","descricao":null,"sku":"CAM-PRE-M","codigo_barras":"7891234567895","unidade":"UN","categoria":"Vestu\u00e1rio","preco_venda":49.9,"preco_atacado":39.9,"ativo":true,"controla_estoque":true,"estoque_disponivel":13,"atualizado_em":"2026-10-23T10:00:00-03:00"}],"meta":{"pagina":1,"por_pagina":25,"total":1,"ultima_pagina":1}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/produtos\/{id}":{"get":{"summary":"Detalha produtos com pre\u00e7o e estoque dispon\u00edvel pelo id","description":"Exige o escopo produtos:ler. Id de outra empresa responde 404.","operationId":"detalhar_produtos","security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Objeto em {data}.","content":{"application\/json":{"example":{"data":{"id":812,"nome":"Camiseta b\u00e1sica preta M","descricao":null,"sku":"CAM-PRE-M","codigo_barras":"7891234567895","unidade":"UN","categoria":"Vestu\u00e1rio","preco_venda":49.9,"preco_atacado":39.9,"ativo":true,"controla_estoque":true,"estoque_disponivel":13,"atualizado_em":"2026-10-23T10:00:00-03:00"}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/clientes":{"get":{"summary":"Lista clientes","description":"Exige o escopo clientes:ler.","operationId":"listar_clientes","security":[{"token":[]}],"parameters":[{"name":"busca","in":"query","required":false,"description":"Nome, e-mail ou telefone, com ou sem m\u00e1scara e em formato internacional (5575998765432).","schema":{"type":"string"}},{"name":"ativo","in":"query","required":false,"description":"1 ou 0.","schema":{"type":"string"}},{"name":"atualizado_desde","in":"query","required":false,"description":"Data\/hora ISO 8601.","schema":{"type":"string"}},{"name":"pagina","in":"query","required":false,"description":"P\u00e1gina (come\u00e7a em 1).","schema":{"type":"integer"}},{"name":"por_pagina","in":"query","required":false,"description":"Itens por p\u00e1gina (1 a 100, padr\u00e3o 25).","schema":{"type":"integer"}}],"responses":{"200":{"description":"Lista paginada: {data: [...], meta: {pagina, por_pagina, total, ultima_pagina}}.","content":{"application\/json":{"example":{"data":[{"id":301,"tipo":"pf","nome":"Maria Souza","razao_social":null,"nome_fantasia":null,"email":"maria@exemplo.com","telefone":null,"celular":"(75) 99876-5432","bairro":"Centro","cidade":"Itatim","uf":"BA","ativo":true,"criado_em":"2026-03-02T09:15:00-03:00","atualizado_em":"2026-10-20T16:40:00-03:00"}],"meta":{"pagina":1,"por_pagina":25,"total":1,"ultima_pagina":1}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/clientes\/{id}":{"get":{"summary":"Detalha clientes pelo id","description":"Exige o escopo clientes:ler. Id de outra empresa responde 404.","operationId":"detalhar_clientes","security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Objeto em {data}.","content":{"application\/json":{"example":{"data":{"id":301,"tipo":"pf","nome":"Maria Souza","razao_social":null,"nome_fantasia":null,"email":"maria@exemplo.com","telefone":null,"celular":"(75) 99876-5432","bairro":"Centro","cidade":"Itatim","uf":"BA","ativo":true,"criado_em":"2026-03-02T09:15:00-03:00","atualizado_em":"2026-10-20T16:40:00-03:00"}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/pedidos-venda":{"get":{"summary":"Lista pedidos de venda","description":"Exige o escopo pedidos:ler. Requer o m\u00f3dulo Com\u00e9rcio no plano.","operationId":"listar_pedidos_venda","security":[{"token":[]}],"parameters":[{"name":"status","in":"query","required":false,"description":"Situa\u00e7\u00e3o do pedido.","schema":{"type":"string"}},{"name":"cliente_id","in":"query","required":false,"description":"Id do cliente.","schema":{"type":"integer"}},{"name":"de","in":"query","required":false,"description":"Criados a partir de (AAAA-MM-DD).","schema":{"type":"string"}},{"name":"ate","in":"query","required":false,"description":"Criados at\u00e9 (AAAA-MM-DD).","schema":{"type":"string"}},{"name":"pagina","in":"query","required":false,"description":"P\u00e1gina (come\u00e7a em 1).","schema":{"type":"integer"}},{"name":"por_pagina","in":"query","required":false,"description":"Itens por p\u00e1gina (1 a 100, padr\u00e3o 25).","schema":{"type":"integer"}}],"responses":{"200":{"description":"Lista paginada: {data: [...], meta: {pagina, por_pagina, total, ultima_pagina}}.","content":{"application\/json":{"example":{"data":[{"id":77,"numero":"PV-0077","status":"aprovado","cliente":{"id":301,"nome":"Maria Souza"},"subtotal":100,"desconto":0,"total":100,"condicao_pagamento":"\u00c0 vista","validade":"2026-10-30","data_entrega":null,"venda_id":null,"criado_em":"2026-10-22T11:00:00-03:00"}],"meta":{"pagina":1,"por_pagina":25,"total":1,"ultima_pagina":1}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/pedidos-venda\/{id}":{"get":{"summary":"Detalha pedidos de venda pelo id","description":"Exige o escopo pedidos:ler. Id de outra empresa responde 404.","operationId":"detalhar_pedidos_venda","security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Objeto em {data}.","content":{"application\/json":{"example":{"data":{"id":77,"numero":"PV-0077","status":"aprovado","cliente":{"id":301,"nome":"Maria Souza"},"subtotal":100,"desconto":0,"total":100,"condicao_pagamento":"\u00c0 vista","validade":"2026-10-30","data_entrega":null,"venda_id":null,"criado_em":"2026-10-22T11:00:00-03:00","itens":[{"produto_id":812,"descricao":"Camiseta b\u00e1sica preta M","quantidade":2,"preco_unitario":50,"desconto":0,"total":100}]}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/pedidos-delivery":{"get":{"summary":"Lista pedidos de delivery (sem pedidos do iFood)","description":"Exige o escopo pedidos:ler. Requer o m\u00f3dulo Food no plano.","operationId":"listar_pedidos_delivery","security":[{"token":[]}],"parameters":[{"name":"status","in":"query","required":false,"description":"aguardando_confirmacao, aceito, em_preparo, pronto, saiu_para_entrega, entregue ou cancelado.","schema":{"type":"string"}},{"name":"cliente_id","in":"query","required":false,"description":"Id do cliente.","schema":{"type":"integer"}},{"name":"telefone","in":"query","required":false,"description":"Telefone do cliente, com ou sem m\u00e1scara (m\u00ednimo 4 d\u00edgitos; menos que isso responde 422).","schema":{"type":"string"}},{"name":"de","in":"query","required":false,"description":"Criados a partir de (AAAA-MM-DD).","schema":{"type":"string"}},{"name":"ate","in":"query","required":false,"description":"Criados at\u00e9 (AAAA-MM-DD).","schema":{"type":"string"}},{"name":"pagina","in":"query","required":false,"description":"P\u00e1gina (come\u00e7a em 1).","schema":{"type":"integer"}},{"name":"por_pagina","in":"query","required":false,"description":"Itens por p\u00e1gina (1 a 100, padr\u00e3o 25).","schema":{"type":"integer"}}],"responses":{"200":{"description":"Lista paginada: {data: [...], meta: {pagina, por_pagina, total, ultima_pagina}}.","content":{"application\/json":{"example":{"data":[{"id":4102,"status":"saiu_para_entrega","cliente_id":301,"cliente_nome":"Maria Souza","cliente_telefone":"(75) 99876-5432","endereco_entrega":{"logradouro":"Rua das Flores","numero":"12","complemento":"ap 3","bairro":"Centro","cidade":"Itatim","uf":"BA","cep":"44000-000","referencia":"port\u00e3o azul"},"subtotal":40,"desconto":0,"taxa_entrega":5,"total":45,"forma_pagamento":"pix","pix_confirmado":true,"tempo_estimado_min":40,"criado_em":"2026-10-23T19:02:00-03:00","aceito_em":"2026-10-23T19:03:00-03:00","saiu_para_entrega_em":"2026-10-23T19:35:00-03:00","entregue_em":null,"cancelado_em":null}],"meta":{"pagina":1,"por_pagina":25,"total":1,"ultima_pagina":1}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/pedidos-delivery\/{id}":{"get":{"summary":"Detalha pedidos de delivery (sem pedidos do iFood) pelo id","description":"Exige o escopo pedidos:ler. Id de outra empresa responde 404.","operationId":"detalhar_pedidos_delivery","security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Objeto em {data}.","content":{"application\/json":{"example":{"data":{"id":4102,"status":"saiu_para_entrega","cliente_id":301,"cliente_nome":"Maria Souza","cliente_telefone":"(75) 99876-5432","endereco_entrega":{"logradouro":"Rua das Flores","numero":"12","complemento":"ap 3","bairro":"Centro","cidade":"Itatim","uf":"BA","cep":"44000-000","referencia":"port\u00e3o azul"},"subtotal":40,"desconto":0,"taxa_entrega":5,"total":45,"forma_pagamento":"pix","pix_confirmado":true,"tempo_estimado_min":40,"criado_em":"2026-10-23T19:02:00-03:00","aceito_em":"2026-10-23T19:03:00-03:00","saiu_para_entrega_em":"2026-10-23T19:35:00-03:00","entregue_em":null,"cancelado_em":null,"observacoes":null,"motivo_cancelamento":null,"itens":[{"nome":"Pizza grande","quantidade":1,"preco_unitario":40,"total":40,"observacao":null}]}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/notas-servico":{"get":{"summary":"Lista notas fiscais de servi\u00e7o (NFS-e)","description":"Exige o escopo nfse:ler. Requer o m\u00f3dulo Com\u00e9rcio, Oficina ou CellTECH no plano. O campo ambiente vem \"teste\" enquanto a empresa emite na produ\u00e7\u00e3o restrita do governo: a nota de teste n\u00e3o vale como documento fiscal.","operationId":"listar_notas_servico","security":[{"token":[]}],"parameters":[{"name":"status","in":"query","required":false,"description":"rascunho, transmitindo, autorizada, rejeitada, cancelada ou pendente_acao.","schema":{"type":"string"}},{"name":"cliente_id","in":"query","required":false,"description":"Id do cliente.","schema":{"type":"integer"}},{"name":"competencia_de","in":"query","required":false,"description":"Compet\u00eancia a partir de (AAAA-MM-DD).","schema":{"type":"string"}},{"name":"competencia_ate","in":"query","required":false,"description":"Compet\u00eancia at\u00e9 (AAAA-MM-DD).","schema":{"type":"string"}},{"name":"busca","in":"query","required":false,"description":"Tomador, n\u00famero da nota ou descri\u00e7\u00e3o.","schema":{"type":"string"}},{"name":"pagina","in":"query","required":false,"description":"P\u00e1gina (come\u00e7a em 1).","schema":{"type":"integer"}},{"name":"por_pagina","in":"query","required":false,"description":"Itens por p\u00e1gina (1 a 100, padr\u00e3o 25).","schema":{"type":"integer"}}],"responses":{"200":{"description":"Lista paginada: {data: [...], meta: {pagina, por_pagina, total, ultima_pagina}}.","content":{"application\/json":{"example":{"data":[{"id":15,"status":"autorizada","ambiente":"teste","numero_nfse":"15","chave_acesso":null,"cliente_id":301,"tomador_nome":"Maria Souza","descricao_servico":"Manuten\u00e7\u00e3o de equipamento","valor_servico":150,"aliquota_iss":2,"valor_iss":3,"iss_retido":false,"data_competencia":"2026-10-01","emitida_em":"2026-10-01T10:00:00-03:00","autorizada_em":"2026-10-01T10:00:20-03:00","cancelada_em":null,"motivo_cancelamento":null,"rejeitada":false}],"meta":{"pagina":1,"por_pagina":25,"total":1,"ultima_pagina":1}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}},"\/notas-servico\/{id}":{"get":{"summary":"Detalha notas fiscais de servi\u00e7o (NFS-e) pelo id","description":"Exige o escopo nfse:ler. Id de outra empresa responde 404.","operationId":"detalhar_notas_servico","security":[{"token":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Objeto em {data}.","content":{"application\/json":{"example":{"data":{"id":15,"status":"autorizada","ambiente":"teste","numero_nfse":"15","chave_acesso":null,"cliente_id":301,"tomador_nome":"Maria Souza","descricao_servico":"Manuten\u00e7\u00e3o de equipamento","valor_servico":150,"aliquota_iss":2,"valor_iss":3,"iss_retido":false,"data_competencia":"2026-10-01","emitida_em":"2026-10-01T10:00:00-03:00","autorizada_em":"2026-10-01T10:00:20-03:00","cancelada_em":null,"motivo_cancelamento":null,"rejeitada":false}}}}},"401":{"description":"Token inv\u00e1lido, expirado ou revogado."},"403":{"description":"Sem escopo, plano sem o m\u00f3dulo ou assinatura inativa."},"404":{"description":"N\u00e3o encontrado (inclui registro de outra empresa)."},"422":{"description":"Par\u00e2metro inv\u00e1lido (data fora do formato, telefone com menos de 4 d\u00edgitos)."},"429":{"description":"Limite de requisi\u00e7\u00f5es excedido."}}}}},"components":{"securitySchemes":{"token":{"type":"http","scheme":"bearer"}}}}