Documentação da API REST

Consulta pública das rotas. Autenticação nas integrações com Bearer (plano Prime).

Base URL

/public/api

Prefixo das rotas: /api/… · Métodos: GET e POST apenas (não há DELETE/PUT) · JSON em request e response · Headers: Accept: application/json · POST: Content-Type: application/json

Autenticação

Integrações (Prime): header Authorization: Bearer <token>
Sessão no navegador: cookie de login; POSTs exigem X-CSRF-Token quando não houver Bearer.

Erros no formato {"error":"…"} (opcionalmente message). Em GET clientes, dados pessoais seguem máscara LGPD conforme o perfil (token Bearer usa visão de integração).

Códigos HTTP

Código	Significado
200	Aceito — requisição OK (GET e POST bem-sucedidos retornam JSON com os dados; muitos POSTs incluem `ok: true`)
401	Não autorizado (sem sessão ou Bearer inválido)
403	Plano/permissão insuficiente (ex.: módulo fiscal)
404	Rota inexistente
405	Método HTTP não permitido na rota
422	Validação / regra de negócio
500	Erro interno

Documentação somente leitura. Para executar chamadas reais, abra o portal de testes.

Pessoas

Tela Pessoas (/clientes) e veículos do cadastro.

Implementation Notes

Busca clientes por texto ou placa. Resposta: id, nome, cpf_cnpj, telefones, cidade, preferências de pagamento; opcional placa_busca/veiculo_id_busca. Dados mascarados conforme LGPD (Bearer = visão integração).

HTTP: 200 401

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`q`	`{joao`	Texto de busca (nome, documento ou placa).	`query`	`string` · {q}

Response Class (Status 200)

Example Value

{
  "items": [
    {
      "id": 1,
      "nome": "João Silva",
      "cpf_cnpj": "***.***.***-00",
      "telefone": "11999990000",
      "cidade": "São Paulo"
    }
  ]
}

Implementation Notes

Cadastra pessoa física ou jurídica. Campos principais: nome (ou nome_completo), tipo_pessoa (fisica|juridica), cpf_cnpj, telefone, whatsapp, email, endereço (cep, logradouro, numero, bairro, cidade, uf). PJ: razao_social, nome_fantasia. Sem DELETE na API — exclusões não estão expostas. Requer permissão clientes.criar (sessão) ou Bearer Prime.

HTTP: 200 401 403 422

Parameters — body

Parameter content type: application/json

Example Value

{"nome":"Maria Souza","tipo_pessoa":"fisica","cpf_cnpj":"529.982.247-25","telefone":"11988887777","email":"[email protected]","cidade":"São Paulo","uf":"SP"}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "cliente_id": 42,
  "item": { "id": 42, "nome": "Maria Souza", "cpf_cnpj": "529.982.247-25" }
}

Implementation Notes

Retorna veículos do cliente. Query obrigatória: cliente_id.

HTTP: 200 401

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`cliente_id` *	`{1`	ID do cliente.	`query`	`integer` · {cliente_id}

Response Class (Status 200)

Example Value

{
  "items": [
    {
      "id": 10,
      "cliente_id": 1,
      "placa": "ABC1D23",
      "modelo": "Gol",
      "marca": "VW",
      "cor": "Prata",
      "motor": "1.0",
      "km_inicial": 85000,
      "ano": 2018,
      "ativo": 1
    }
  ]
}

Implementation Notes

Cadastra veículo vinculado ao cliente. Obrigatórios: cliente_id e placa. Opcionais: modelo, marca, cor, motor, km_inicial, ano. Se o cliente estiver no carrinho do PDV, o veículo novo já fica selecionado.

HTTP: 200 401 422

Parameters — body

Parameter content type: application/json

Example Value

{"cliente_id":1,"placa":"ABC1D23","modelo":"Argo","marca":"Fiat","cor":"Prata","motor":"1.3","km_inicial":10230,"ano":2020}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "veiculo_id": 10,
  "placa": "ABC1D23"
}

Produtos

Tela Produtos (/produtos).

Implementation Notes

Busca por nome, código interno ou barras (até 80 itens; q vazio devolve lista vazia). Inclui preços, estoque (decimal), unidade (UN, L, KG…), permite_fracao, estoque_critico (mínimo cadastrado), estoque_critico_flag (saldo crítico), sem_estoque e foto_url.

HTTP: 200 401

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`q`	`{oleo`	Texto de busca.	`query`	`string` · {q}
`tipo_item`	`{produto`	Filtro: produto \| insumo \| mao_obra \| hora_tecnica.	`query`	`string` · {tipo_item}

Response Class (Status 200)

Example Value

{
  "items": [
    {
      "id": 1,
      "nome": "Óleo 5W30",
      "tipo_item": "produto",
      "preco": 45.9,
      "preco_modo": "varejo",
      "preco_varejo": 45.9,
      "preco_atacado": 41.3,
      "estoque": 12.5,
      "unidade": "L",
      "permite_fracao": true,
      "codigo_interno": "OLEO5W30",
      "codigo_barras": "7890000000001",
      "estoque_critico": 5,
      "limite_critico_efetivo": 5,
      "estoque_critico_flag": false,
      "sem_estoque": false,
      "tem_foto": false,
      "foto_url": null
    }
  ]
}

Implementation Notes

Cadastro essencial: nome (obrigatório), tipo_item (produto|insumo|mao_obra|hora_tecnica), preco ou preco_varejo, opcionais codigo_interno, codigo_barras, estoque (decimal), estoque_critico, unidade (UN, PC, PAR, JG, KIT, CX, L, ML, KG, G, M, M2, H; padrão UN), permite_fracao (liga sozinho para insumo), ativo, ncm, cest, cfop. Sem DELETE na API. Requer produtos.criar (sessão) ou Bearer Prime.

HTTP: 200 401 403 422

Parameters — body

Parameter content type: application/json

Example Value

{"nome":"Óleo 5W30","tipo_item":"produto","preco":45.9,"codigo_interno":"OLEO5W30","estoque":10.5,"unidade":"L","permite_fracao":true,"ativo":true}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "produto_id": 88,
  "nome": "Óleo 5W30",
  "tipo_item": "produto",
  "preco": 45.9,
  "unidade": "L",
  "estoque": 10.5
}

Relatórios · Pedidos

Listagem em Relatórios → Pedidos (/relatorios?tab=pedidos).

Implementation Notes

Lista documentos do período. Itens trazem entrega, cancelamento e meta fiscal.

HTTP: 200 401 422

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`de` *	`{2026-01-01`	Data inicial (YYYY-MM-DD).	`query`	`string` · {de}
`ate` *	`{2026-12-31`	Data final (YYYY-MM-DD).	`query`	`string` · {ate}
`tipo`	`{os`	Filtro de tipo (ex.: os, pedido, orcamento).	`query`	`string` · {tipo}
`situacao`	`{pag_pendente`	Situação / status (ex.: pag_pendente).	`query`	`string` · {situacao}
`busca`	`{`	Busca por cliente / documento (aliases: q, cliente).	`query`	`string` · {busca}

Response Class (Status 200)

Example Value

{
  "items": [
    {
      "id": 1257,
      "numero_documento": 58,
      "label_documento": "OS nº 58",
      "cliente_id": 1,
      "cliente_nome": "Cliente Mock",
      "data": "2026-10-24 10:00:00",
      "tipo": "os",
      "tipo_documento": 2,
      "status": "em_atendimento",
      "status_label": "Em atend.",
      "total": 350.0,
      "faturado": 0,
      "gera_financeiro": false,
      "gera_estoque": false,
      "gera_nf": false,
      "origem_pedido_id": null,
      "pedido_convertido_id": null,
      "observacao": "Revisão 10 mil km",
      "motivo_entrada": "Revisão",
      "data_inicio": "2026-10-24",
      "data_fim": null,
      "faturamento_status": "editavel",
      "faturamento_status_label": "Editável",
      "data_prevista_cobranca": null,
      "concluido_em": null,
      "data_entrega": null,
      "observacao_entrega": null,
      "motivo_cancelamento": null,
      "cancelado_em": null,
      "nota_fiscal_status": "sem_nota",
      "nota_fiscal_label": "Sem nota",
      "nota_fiscal_id": null,
      "pode_faturar_standby": false,
      "pode_encerrar_faturamento": false,
      "pode_reabrir": false,
      "pedido_bloqueado_edicao": false,
      "documentos": [{ "id": 1257, "tipo": "os", "numero_documento": 58, "label": "OS nº 58", "principal": true }],
      "orcamento_vinculo": null,
      "convertido_vinculo": null,
      "orcamento_bloqueado": false
    }
  ]
}

PDV / OS — Carrinho

Montagem do atendimento: cliente, itens, descontos e cupom.

Implementation Notes

Carrinho da sessão: cart[] (com tipo_item, qtd decimal, unidade, permite_fracao e desconto por linha), totais, cupom, pagamentos, contas financeiras, formas de pagamento, naturezas, pdv_config (inclui insumos_modo, insumos_baixa_estoque, insumos_nota), alerta de sangria, plano e limites fiscais. Com pedido_id na sessão, vem também a meta do documento. Esta resposta não tem a chave ok; todas as rotas que alteram o carrinho devolvem o mesmo formato.

HTTP: 200 401

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Diz qual documento fiscal a natureza vai gerar (nfe, nfse ou nfce) e o que falta no cadastro do cliente para emitir. generico = cliente sem CPF/CNPJ válido. Sem parâmetros válidos devolve documento: null e lista vazia (sempre HTTP 200).

HTTP: 200 401

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`cliente_id` *	`{1`	ID do cliente.	`query`	`integer` · {cliente_id}
`natureza_id` *	`{1`	ID da natureza de operação.	`query`	`integer` · {natureza_id}

Response Class (Status 200)

Example Value

{
  "documento": "nfe",
  "pendencias": ["Informe o CEP do cliente."],
  "generico": false,
  "editar_url": "https://…/clientes/editar?id=1"
}

Implementation Notes

Define o cliente do carrinho (null remove). Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"cliente_id":1}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Define o veículo (0 remove). Exige cliente no carrinho e veículo ativo dele. Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"veiculo_id":1}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Atualiza os campos personalizados do documento (objeto campos_extras). Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"campos_extras":{"placa_reboque":"XYZ9A87"}}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Seleciona um registro salvo de campos do cliente. registro_id é texto: id do registro, "" (nenhum) ou "novo". Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"registro_id":"7"}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Grava os campos_extras como registro do cliente. A resposta traz o carrinho mais registro_salvo e registro_id. Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"campos_extras":{"placa_reboque":"XYZ9A87"}}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Adiciona item: produto_id, qtd (decimal com até 3 casas só se o produto tiver permite_fracao; senão 422), opcionais valor_unitario e tipo (tipo do documento, para validar o tipo do item: insumo não entra em Pedido). Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"produto_id":1,"qtd":0.5}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Altera item: index; opcional qtd (mesma regra de fração), desconto/desconto_modo, nome, valor_unitario. Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"index":0,"qtd":2,"nome":"Óleo 5W30","valor_unitario":45.9}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Remove item pelo índice. Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"index":0}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Desconto manual: desconto, desconto_modo (reais|percent), opcional cpf_destinatario (revalida o cupom) — independente do cupom. Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"desconto":0,"desconto_modo":"reais","cpf_destinatario":""}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Aplica cupom (codigo; opcional cpf_destinatario). Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"codigo":"PROMO10","cpf_destinatario":""}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Remove cupom do carrinho (body vazio {}). Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Analisa as regras de manutenção do veículo e devolve o que está vencido (vermelho), perto de vencer (amarelo), em dia (verde) ou sem histórico. Body: veiculo_id, opcional veiculo_km (km atual). Sem veiculo_id: itens vazio e msg. Só leitura.

HTTP: 200 401 404 419

Parameters — body

Parameter content type: application/json

Example Value

{"veiculo_id":1,"veiculo_km":20500}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "veiculo_id": 1,
  "veiculo_km": 20500,
  "itens": [
    {
      "regra_id": 3,
      "produto_id": 1,
      "nome": "Óleo 5W30",
      "tipo_manutencao": "troca",
      "descricao": "Troca de óleo do motor",
      "intervalo_km": 10000,
      "intervalo_meses": 6,
      "nivel": "vermelho",
      "situacao": "Vencida há 270 km",
      "ultima_km": 10230,
      "ultima_data": "2026-05-01",
      "proxima_km": 20230,
      "proxima_data": "2026-11-01",
      "km_excedido": 270,
      "pedido_id": 1257
    }
  ]
}

PDV / OS — Criar / abrir

Criar OS/pedido, carregar, reabrir ou duplicar documento.

Implementation Notes

Carrega pedido no carrinho (pedido_id). A resposta é o carrinho mais a meta do documento (numero_documento, label_documento, situação, faturamento, documentos[] vinculados, pode_reabrir…). Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Reabre documento encerrado para edição. Exige motivo_reabrir (mínimo 5 caracteres), exceto com intencao: "faturar" (documentos concluídos com faturamento pendente). Resposta igual a carregar, com reaberto. Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1,"motivo_reabrir":"Cliente pediu inclusão de item"}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Copia os itens do pedido para um carrinho novo (não grava). A resposta traz duplicado_de, tipo_sugerido, observacao e motivo_entrada. Resposta: carrinho completo (formato de GET pdv/cart).

HTTP: 200 401 404 419 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1}

Response Class (Status 200)

Example Value

{
  "cart": [
    {
      "produto_id": 1,
      "nome": "Óleo 5W30 sintético",
      "qtd": 4.0,
      "valor_unitario": 45.5,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 182.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "produto",
      "unidade": "L",
      "permite_fracao": true
    },
    {
      "produto_id": 2,
      "nome": "Graxa multiuso",
      "qtd": 0.25,
      "valor_unitario": 60.0,
      "tem_foto": false,
      "desconto_tipo": "reais",
      "desconto_valor": 0.0,
      "subtotal_linha": 15.0,
      "desconto_efetivo": 0.0,
      "tipo_item": "insumo",
      "unidade": "KG",
      "permite_fracao": true
    }
  ],
  "subtotal": 197.0,
  "desconto": 0,
  "desconto_manual": 0,
  "desconto_cupom": 0,
  "desconto_modo": "reais",
  "desconto_valor_campo": 0,
  "cupom": null,
  "total": 197.0,
  "total_recebido": 0,
  "saldo_pagar": 197.0,
  "cliente_id": 1,
  "cliente_nome": "Cliente Mock",
  "veiculo_id": 1,
  "campos_extras": {},
  "campos_registro_id": "",
  "campos_registros": [],
  "pedido_id": null,
  "pagamentos": [],
  "contas_financeiras": [{ "id": 2, "descricao": "Banco Mock", "tipo": "banco", "formas_padrao": ["pix"], "saldo_atual": 12500.0 }],
  "formas_pagamento": [{ "codigo": "pix", "value": "pix", "label": "PIX" }],
  "naturezas_operacao": [{ "id": 1, "codigo": "venda", "descricao": "Venda de mercadoria", "tipo_documento": "nfe", "cfop": "5102", "movimenta_estoque": true, "gera_financeiro": true, "emite_sem_faturar": false }],
  "pdv_config": {
    "exibir_veiculo": true,
    "exigir_veiculo": false,
    "exigir_km_os": false,
    "veiculo_km_formato": "bruto",
    "orcamento_validade_dias": 15,
    "campos_personalizados": [],
    "formas_ativas": ["dinheiro", "pix", "cartao_debito", "cartao_credito", "boleto"],
    "formas_favoritas": ["pix"],
    "etapa_extra": false,
    "titulo_etapa": "",
    "insumos_modo": "separado",
    "insumos_baixa_estoque": true,
    "insumos_nota": "nfe"
  },
  "sangria_alerta": { "ativo": false, "alerta": false, "saldo": 350.0, "limite": 0.0, "sugerido": 0.0, "pode_registrar": true, "dia": "2026-10-24", "url_caixa": "https://…/caixa" },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "empresa": { "id": 1, "nome": "Oficina Mock LTDA", "regime_fiscal": "mei", "logo_url": "https://…/empresa-logo?empresa_id=1", "logo_modo": "upload" }
}

Implementation Notes

Cria um novo documento. Padrão: tipo=os (ordem de serviço). Também aceita pedido ou orcamento. Body: cliente_id, items[] (produto_id, qtd decimal se o produto permitir fração; preço/nome preenchidos do cadastro se omitidos), opcionais veiculo_id, observacao, motivo_entrada, data_inicio, data_fim, status (padrão aberto). Por padrão faturado=false (só grava). Para faturar na criação, envie faturado:true e pagamentos (como em pdv/finalizar). Requer plano com OS (para tipo os/orcamento) e permissão pdv.criar ou pdv.editar. A resposta tem o mesmo formato de pdv/finalizar.

HTTP: 200 401 403 422

Parameters — body

Parameter content type: application/json

Example Value

{"cliente_id":1,"veiculo_id":null,"tipo":"os","status":"aberto","observacao":"Revisão 10 mil","items":[{"produto_id":1,"qtd":4},{"produto_id":2,"qtd":0.25},{"produto_id":3,"qtd":1,"valor_unitario":80}]}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "atualizado": false,
  "pedido_id": 1001,
  "numero_documento": 59,
  "documento_label": "OS nº 59",
  "tipo": "os",
  "tipo_documento": 2,
  "total": 277.0,
  "cliente_nome": "Cliente Mock",
  "public_document_url": "https://…/documento/public?t=…",
  "pagamentos": [],
  "total_recebido": 0,
  "saldo_pagar": 277.0,
  "fiscal": { "emitido": false, "nfse": null, "nfe": null },
  "faturado_sem_emissao": false,
  "titulo_receber_id": null,
  "faturado": 0,
  "status": "aberto",
  "status_label": "Aberto",
  "faturamento_status": "editavel",
  "nota_fiscal_status": "sem_nota"
}

PDV / OS — Fechamento

Finalização e faturamento do documento.

Implementation Notes

Finaliza pedido/OS/orçamento.

pedido_id — ao editar documento já aberto
faturado, concluir, concluir_sem_nota, concluir_pag_pendente
modo_fiscal: auto | somente_nfse | servico | produto
Pagamento único: forma, valor_recebido, parcelas, conta_financeira_id
Vários: pagamentos[] (forma, valor, troco, parcelas)
Fiscal: natureza_operacao_id, nota_referencia_id, faturar_sem_emissao, nfse_descricao, cpf_destinatario, nfe_inf_compl ({"enviado":true,"opcoes":["simples","ipi"],"texto":""}; opções em GET pdv/inf-complementar)
Documento: observacao, motivo_entrada, data_inicio, data_fim, veiculo_km, campos_extras, desconto/desconto_modo, data_prevista_cobranca, acao_orcamento_aprovado, motivo_cancelamento
Sem sessão de PDV (Bearer): items[] como em pdv/criar

Se a nota falhar, o faturamento é revertido e a resposta é 422 com fiscal_erro, fiscal e faturado:false.

HTTP: 200 401 403 422 500

Parameters — body

Parameter content type: application/json

Example Value

{"cliente_id":1,"veiculo_id":null,"tipo":"pedido","status":"aberto","faturado":true,"concluir_pag_pendente":false,"modo_fiscal":"auto","forma":"cartao_credito","valor_recebido":91,"parcelas":3,"pagamentos":[{"forma":"cartao_credito","valor":91,"troco":0,"parcelas":3}]}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "atualizado": false,
  "pedido_id": 9999,
  "numero_documento": 120,
  "documento_label": "Pedido nº 120",
  "tipo": "pedido",
  "tipo_documento": 3,
  "total": 197.0,
  "gera_financeiro": true,
  "gera_estoque": true,
  "gera_nf": true,
  "natureza_operacao_id": 1,
  "cliente_nome": "Cliente Mock",
  "public_document_url": "https://…/documento/public?t=…",
  "public_document_expires_at": "2026-11-23 10:00:00",
  "pagamentos": [{ "id": 501, "forma": "pix", "valor": 197.0, "troco": 0, "parcelas": null, "conta_financeira_id": 2, "conta_descricao": "Banco Mock", "etapa": "faturamento", "created_at": "2026-10-24 10:05:00" }],
  "comprovante_codigo": "CMP-9999",
  "fiscal_limites_mes": { "nfe": { "limite": 50, "usado": 4, "restante": 46, "ilimitado": false, "bloqueado": false, "permitido": true } },
  "mes_referencia": "10/2026",
  "fiscal": {
    "emitido": true,
    "nfse": null,
    "nfe": { "emitido": true, "ok": true, "mensagem": "NF-e autorizada.", "chave": "3526…1234", "nota_id": 321 }
  },
  "nfse": null,
  "nfe": { "emitido": true, "ok": true, "mensagem": "NF-e autorizada.", "chave": "3526…1234", "nota_id": 321 },
  "faturado_sem_emissao": false,
  "titulo_receber_id": 900,
  "faturado": 1,
  "status": "concluido",
  "status_label": "Concluído",
  "faturamento_status": "faturado",
  "faturamento_status_label": "Faturado",
  "nota_fiscal_status": "autorizada",
  "nota_fiscal_label": "Autorizada",
  "nota_fiscal_id": 321,
  "pode_reabrir": false,
  "pedido_bloqueado_edicao": false
}

PDV / OS — Entrega e cancelamento

Pós-venda: entrega e cancelamento com opções de estorno.

Implementation Notes

Registra entrega (pedido_id, data_entrega YYYY-MM-DD, opcional observacao_entrega).

HTTP: 200 401 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1,"data_entrega":"2026-07-15","observacao_entrega":"Entregue ao cliente"}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "pedido_id": 1,
  "data_entrega": "2026-10-24",
  "observacao_entrega": "Entregue ao cliente",
  "status": "concluido",
  "status_label": "Concluído",
  "faturado": 1,
  "faturamento_status": "faturado",
  "nota_fiscal_status": "autorizada",
  "nota_fiscal_id": 321,
  "pode_reabrir": false,
  "pedido_bloqueado_edicao": false
}

Implementation Notes

Consulta estornos, NF e PIN disponíveis. Use antes de POST pdv/cancelar. Path efetivo: pdv/cancelar-opcoes?pedido_id={pedido_id}.

HTTP: 200 401 422

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`pedido_id` *	`{1`	ID do pedido.	`query`	`integer` · {pedido_id}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "pedido_id": 1,
  "pode_estorno_financeiro": true,
  "pode_estorno_estoque": false,
  "pode_cancelar_nf": false,
  "notas_autorizadas": 0,
  "exige_pin_nf": false,
  "motivo_min_chars": 5,
  "resumo": "Pedido faturado: é possível estornar o financeiro."
}

Implementation Notes

Cancela documento.

pedido_id — obrigatório
motivo ou motivo_cancelamento — mínimo 5 caracteres
Opcionais: estorno_financeiro, estorno_estoque, cancelar_nf, pin_cancelamento

HTTP: 200 401 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1,"motivo":"Cliente desistiu do serviço","estorno_financeiro":true,"estorno_estoque":false,"cancelar_nf":false,"pin_cancelamento":""}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "pedido_id": 1,
  "tipo": "pedido",
  "status": "cancelado",
  "status_label": "Cancelado",
  "motivo_cancelamento": "Cliente desistiu do serviço",
  "cancelado_em": "2026-10-24 14:30:00",
  "efeitos": {
    "nf_canceladas": 0,
    "pagamentos_estornados": 1,
    "titulos_afetados": 1,
    "estoque_itens": 2,
    "mensagens": ["1 pagamento estornado.", "Estoque devolvido de 2 item(ns)."]
  },
  "faturado": 0,
  "faturamento_status": "editavel",
  "nota_fiscal_status": "sem_nota",
  "pode_reabrir": false,
  "pedido_bloqueado_edicao": false
}

PDV / OS — Link / e-mail

Documento público: meta WhatsApp, e-mail e revogação/renovação de link.

Implementation Notes

Meta do pedido (link público, logo, limites fiscais) via query pedido_id.

HTTP: 200 401 404 422

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`pedido_id` *	`{1`	ID do pedido.	`query`	`integer` · {pedido_id}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "pedido_id": 1257,
  "numero_documento": 58,
  "documento_label": "OS nº 58",
  "tipo": "os",
  "status": "em_atendimento",
  "status_label": "Em atendimento",
  "faturado": false,
  "total": 350.0,
  "cliente_nome": "Cliente Mock",
  "public_document_active": true,
  "public_document_ttl_dias": 30,
  "public_document_ttl_label": "30 dias",
  "public_document_expires_at": "2026-11-23 10:00:00",
  "public_document_revoked": false,
  "public_document_expired": false,
  "public_document_path": "/documento/public?t=…",
  "public_document_url": "https://…/documento/public?t=…",
  "public_document_modo": "completo",
  "cliente_whatsapp_digits": "5511988887777",
  "cliente_email": "[email protected]"
}

Implementation Notes

Mesma meta via JSON pedido_id.

HTTP: 200 401 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "pedido_id": 1257,
  "numero_documento": 58,
  "documento_label": "OS nº 58",
  "tipo": "os",
  "status": "em_atendimento",
  "status_label": "Em atendimento",
  "faturado": false,
  "total": 350.0,
  "cliente_nome": "Cliente Mock",
  "public_document_active": true,
  "public_document_ttl_dias": 30,
  "public_document_ttl_label": "30 dias",
  "public_document_expires_at": "2026-11-23 10:00:00",
  "public_document_revoked": false,
  "public_document_expired": false,
  "public_document_path": "/documento/public?t=…",
  "public_document_url": "https://…/documento/public?t=…",
  "public_document_modo": "completo",
  "cliente_whatsapp_digits": "5511988887777",
  "cliente_email": "[email protected]"
}

Implementation Notes

Envia link do documento por e-mail (pedido_id; renova se expirado). Resposta: message + meta do documento.

HTTP: 200 401 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "message": "E-mail enviado ao cliente com o link do documento.",
  "pedido_id": 1257,
  "numero_documento": 58,
  "documento_label": "OS nº 58",
  "tipo": "os",
  "status": "em_atendimento",
  "status_label": "Em atendimento",
  "faturado": false,
  "total": 350.0,
  "cliente_nome": "Cliente Mock",
  "public_document_active": true,
  "public_document_ttl_dias": 30,
  "public_document_ttl_label": "30 dias",
  "public_document_expires_at": "2026-11-23 10:00:00",
  "public_document_revoked": false,
  "public_document_expired": false,
  "public_document_path": "/documento/public?t=…",
  "public_document_url": "https://…/documento/public?t=…",
  "public_document_modo": "completo",
  "cliente_whatsapp_digits": "5511988887777",
  "cliente_email": "[email protected]"
}

Implementation Notes

Revoga link público (pedido_id). Resposta: message + meta do documento.

HTTP: 200 401 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "message": "Link público revogado. Links anteriores deixam de funcionar.",
  "pedido_id": 1257,
  "numero_documento": 58,
  "documento_label": "OS nº 58",
  "tipo": "os",
  "status": "em_atendimento",
  "status_label": "Em atendimento",
  "faturado": false,
  "total": 350.0,
  "cliente_nome": "Cliente Mock",
  "public_document_active": true,
  "public_document_ttl_dias": 30,
  "public_document_ttl_label": "30 dias",
  "public_document_expires_at": "2026-11-23 10:00:00",
  "public_document_revoked": false,
  "public_document_expired": false,
  "public_document_path": "/documento/public?t=…",
  "public_document_url": "https://…/documento/public?t=…",
  "public_document_modo": "completo",
  "cliente_whatsapp_digits": "5511988887777",
  "cliente_email": "[email protected]"
}

Implementation Notes

Gera novo link (invalida o anterior) e envia e-mail se houver endereço. Resposta: message, email_enviado + meta do documento.

HTTP: 200 401 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "message": "Novo link gerado e enviado por e-mail ao cliente.",
  "email_enviado": true,
  "pedido_id": 1257,
  "numero_documento": 58,
  "documento_label": "OS nº 58",
  "tipo": "os",
  "status": "em_atendimento",
  "status_label": "Em atendimento",
  "faturado": false,
  "total": 350.0,
  "cliente_nome": "Cliente Mock",
  "public_document_active": true,
  "public_document_ttl_dias": 30,
  "public_document_ttl_label": "30 dias",
  "public_document_expires_at": "2026-11-23 10:00:00",
  "public_document_revoked": false,
  "public_document_expired": false,
  "public_document_path": "/documento/public?t=…",
  "public_document_url": "https://…/documento/public?t=…",
  "public_document_modo": "completo",
  "cliente_whatsapp_digits": "5511988887777",
  "cliente_email": "[email protected]"
}

Fiscal

Módulo Fiscal (/fiscal) e encerramento de faturamento pendente.

Implementation Notes

Opções de texto para o campo infCpl da NF-e, já com a marcação padrão (Simples Nacional, IPI e ST conforme natureza e itens). Envie a seleção em pdv/finalizar no campo nfe_inf_compl; o texto livre aceita até max_texto caracteres.

HTTP: 200 401

Parameters

Parameter	Value	Description	Parameter Type	Data Type
`natureza_id`	`{1`	ID da natureza de operação.	`query`	`integer` · {natureza_id}
`pedido_id`	`{1`	ID do pedido (para número e observação).	`query`	`integer` · {pedido_id}
`produto_ids`	`{1,2`	IDs dos produtos do carrinho, separados por vírgula.	`query`	`string` · {produto_ids}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "opcoes": [
    { "id": "simples", "rotulo": "Optante pelo Simples Nacional", "texto": "DOCUMENTO EMITIDO POR ME OPTANTE PELO SIMPLES NACIONAL.", "marcado": true },
    { "id": "ipi", "rotulo": "Não gera crédito de IPI", "texto": "NAO GERA DIREITO A CREDITO FISCAL DE IPI.", "marcado": true },
    { "id": "st", "rotulo": "ICMS recolhido por substituição tributária", "texto": "IMPOSTO RECOLHIDO POR SUBSTITUICAO - ARTIGO 274 DO RICMS.", "marcado": false },
    { "id": "pedido", "rotulo": "Número do pedido/OS", "texto": "Pedido nº 120", "marcado": false },
    { "id": "observacao", "rotulo": "Observação do pedido/OS", "texto": "", "marcado": false }
  ],
  "max_texto": 2000
}

Implementation Notes

Body: pedido_id ou pedido_ids[]; modo conclusao|cancelamento; motivo se cancelamento. Com vários ids, a resposta traz erros em vez de itens. 403 sem módulo fiscal ou sem a permissão fiscal.encerrar_sem_nota (sessão).

HTTP: 200 401 403 422

Parameters — body

Parameter content type: application/json

Example Value

{"pedido_id":1,"modo":"conclusao","motivo":""}

Response Class (Status 200)

Example Value

{
  "ok": true,
  "processados": 1,
  "modo": "conclusao",
  "itens": [
    { "ok": true, "pedido_id": 1, "faturamento_status": "sem_nota", "modo": "conclusao", "status": null }
  ]
}

Empresa · Plano

Contexto em Minha empresa / plano ativo.

Implementation Notes

Empresa (nome, logo, regime), plano, módulos habilitados e limites fiscais do mês.

HTTP: 200 401

Response Class (Status 200)

Example Value

{
  "ok": true,
  "empresa": {
    "id": 1,
    "nome": "Oficina Mock LTDA",
    "razao_social": "Oficina Mock LTDA",
    "cnpj": "00000000000000",
    "regime_fiscal": "mei",
    "logo_url_externa": null,
    "logo_url": "https://…/empresa-logo?empresa_id=1",
    "logo_modo": "upload"
  },
  "plano": "premium",
  "integracao": { "modulo_fiscal": true, "modulo_os_orcamento": true, "modulo_financeiro": true, "modulo_estoque": true, "api_bearer": true },
  "fiscal_limites_mes": {
    "nfe": { "limite": 50, "usado": 3, "restante": 47, "ilimitado": false, "bloqueado": false, "permitido": true },
    "nfse": { "limite": 100, "usado": 10, "restante": 90, "ilimitado": false, "bloqueado": false, "permitido": true },
    "nfce": { "limite": 0, "usado": 0, "restante": null, "ilimitado": true, "bloqueado": false, "permitido": true }
  },
  "mes_referencia": "10/2026"
}

Cookie	Duração	Descrição
`PHPSESSID`	até ~6 h	Identificador de sessão HTTP (PHP). Segurança, CSRF e estado da navegação. Expira em cerca de 6 horas ou no logout — não apenas ao fechar o navegador.
`oficina360_lgpd_consent`	12 meses	Registro do consentimento prestado quanto à Política de Cookies (HttpOnly), conforme LGPD.

Duração

Descrição

PHPSESSID

até ~6 h

Identificador de sessão HTTP (PHP). Segurança, CSRF e estado da navegação. Expira em cerca de 6 horas ou no logout — não apenas ao fechar o navegador.

oficina360_lgpd_consent

12 meses

Registro do consentimento prestado quanto à Política de Cookies (HttpOnly), conforme LGPD.

Chave	Duração	Descrição
`mecanicarSidebarDesktop`	persistente	Estado do menu lateral (expandido ou recolhido) na área autenticada.
`mecanicarValoresVisiveis`	persistente	Exibição ou mascaramento de valores monetários na interface.
`venda_pdv_perguntar_doc`	persistente	Preferência do PDV/venda rápida: se deve perguntar documento (CPF/CNPJ) ao abrir nova venda.
`pdv_kiosk`	aba / sessão	Modo kiosk/tela cheia do PDV nesta aba (`sessionStorage`); some ao fechar a aba.
`api-docs-tester-history`	aba / sessão	Histórico local de requisições no testador da documentação/portal da API (`sessionStorage`).

Chave

Duração

Descrição

mecanicarSidebarDesktop

persistente

Estado do menu lateral (expandido ou recolhido) na área autenticada.

mecanicarValoresVisiveis

persistente

Exibição ou mascaramento de valores monetários na interface.

venda_pdv_perguntar_doc

persistente

Preferência do PDV/venda rápida: se deve perguntar documento (CPF/CNPJ) ao abrir nova venda.

pdv_kiosk

aba / sessão

Modo kiosk/tela cheia do PDV nesta aba (sessionStorage); some ao fechar a aba.

api-docs-tester-history

aba / sessão

Histórico local de requisições no testador da documentação/portal da API (sessionStorage).