API do ERP Escale Mais

Lista todos os produtos da empresa. Suporta filtros:

Cria um novo produto.

Nas respostas, o preço vem em sale_price e o estoque em stock_quantity — são os nomes do cadastro do ERP, e também são aceitos no envio no lugar de price e stock.

Campos para criação/edição:

Filtros na listagem: search (busca por nome, email, telefone ou CPF/CNPJ)

Campos para criação/edição:

Telefone e WhatsApp são gravados só com dígitos e DDI 55. document vai para CPF (até 11 dígitos) ou CNPJ; address é o logradouro. Telefone já cadastrado: o POST atualiza o cliente existente e responde 200 (em vez de 201), sem criar duplicado.

Filtro na listagem: search (nome).

Campos: name (obrigatório), email, phone, document (CPF ou CNPJ — define pessoa física/jurídica), address (logradouro), notes

Campos: name (obrigatório), description. Na edição, também is_active e show_in_pos (aparece no PDV). A mesma categoria serve para produtos e serviços.

Categoria com produtos não pode ser removida (409).

Filtros: search (nome), is_active (true/false). Campos: name (obrigatório, único na empresa), is_active (padrão: true).

A resposta traz products_count. Marca com produtos não pode ser removida (409).

Filtros: search (nome), is_active (true/false). Campos: name (obrigatório), description, location, is_active (padrão: true).

Ao remover, os produtos e lotes do depósito ficam sem depósito — não são apagados.

Filtros: search (placa, modelo…), vehicle_type, customer_id, is_active (true/false).

Campos: vehicle_type (obrigatório: carro, moto, caminhao, outro), plate, model — placa ou modelo é obrigatório —, brand, year, color, fuel (flex, gasolina, etanol, diesel, gnv, eletrico, hibrido), chassis, renavam, engine, current_km, notes, customer_id, is_active.

Veículo com ordens de serviço no histórico é desativado em vez de removido; a resposta do DELETE diz qual aconteceu em deactivated.

Filtros: search, object_type, customer_id, is_active (true/false).

Campos: name (obrigatório, ex.: Notebook Dell Inspiron), object_type (obrigatório: informatica, celular, eletrodomestico, eletronico, maquina, ferramenta, movel, outro), brand, model, serial_number, asset_tag, color, year, accessories, notes, customer_id, is_active.

Objeto com ordens de serviço no histórico é desativado em vez de removido (deactivated na resposta).

Filtros: status (draft, completed), search. Lista: name (padrão: "Lista de dd/mm/aaaa hh:mm"), notes, items (opcional, no mesmo formato do item). Na edição, status marca a lista como concluída ou rascunho.

Item: product_id (do catálogo — nome, SKU, unidade e custo vêm do cadastro) ou name (item avulso), quantity (padrão: 1), unit, unit_cost, note. Na edição do item, também is_purchased.

Produto que já está na lista soma na quantidade da linha existente em vez de duplicar.

Filtros: status (pending, completed, cancelled, refunded), customer_id, start_date, end_date (pela data da venda, YYYY-MM-DD).

Campos para criação:

Total = soma dos itens − descontos + delivery_fee. Produtos com controle de estoque têm a baixa feita na hora (com registro em /stock-movements); venda criada como cancelled não mexe no estoque.

Filtros: status (scheduled, confirmed, in_progress, completed, cancelled, no_show), start_date, end_date (pela data do agendamento), employee_id

Campos para criação:

Edição (PUT): envie só o que muda. date, start_time e end_time são independentes — sem end_time novo, a duração se mantém. service_id troca o serviço do agendamento.

Filtros: status (pending, paid, cancelled), start_date, end_date (pela data da despesa, expense_date)

Filtros: status (pending, received, partial, overdue, cancelled), start_date, end_date (pela data de vencimento, due_date)

Filtros: product_id, type (entry, exit, adjustment, loss, return, transfer)

Filtros: status (open, closed)

Contas: filtros type (bank, cash, other) e is_active (true/false); lista completa, sem paginação. Cada conta traz current_balance = saldo inicial + entradas − saídas.

Extrato (paginado): filtros start_date, end_date, direction (in, out) e source (manual, cash_register_close, expense, receivable, transfer).

Retorna todos os pipelines ativos da empresa com seus estágios (stages) ordenados por posição. Cada estágio possui: name, is_initial, is_final, color.

Retorna: has_config (bool), fee_fixed (taxa fixa), fee_per_km (taxa por km), max_km (raio máximo), latitude, longitude, business_name, business_address, business_city, business_state, business_phone.

Dono e colaboradores ativos da empresa. Cada item traz id, name, role, position (cargo) e work_schedule. O id é o que vai em employee_id nos agendamentos.

Retorna business_hours (o horário configurado no ERP, por dia da semana) e timezone (padrão: America/Sao_Paulo).