{ "openapi": "3.1.0", "info": { "title": "API GestãoClick", "version": "1.0.0", "description": "A Integração via API permite que outros sistemas conversem com o seu, criando, consultando, alterando e excluindo registros pela nuvem.\n\n### Autenticação\n\nGere o **Access Token** e o **Secret Access Token** na tela de Integração via API e envie os dois em todas as requisições, como cabeçalho HTTP:\n\n```\naccess-token: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\nsecret-access-token: YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY\n```\n\n### Limite de requisições\n\nMáximo de **3 requisições por segundo** e **30.000 por dia**, por empresa. Ao ultrapassar, a resposta vem com status `429` e a mensagem *O limite de requisicoes foi atingido*.\n\n### Limites de registros\n\nToda requisição `GET` de listagem é paginada, com no máximo **100 registros por página**. Use `pagina`, `limite`, `ordenacao` e `direcao` para navegar.\n\n### Atribuição de usuário\n\nEmpresas com mais de um usuário devem mandar `usuario_id`. Sem esse campo, a API usa o usuário master. Os ids saem de `GET /usuarios`.\n\n### Atribuição de loja\n\nEmpresas com mais de uma loja devem mandar `loja_id` (na query ou no corpo). Sem esse campo, a API usa a loja matriz ou a loja que o usuário tem permissão de acessar. Os ids saem de `GET /lojas`.\n" }, "servers": [ { "url": "https://app.api.click.app/v1", "description": "Cadastros, produtos e serviços" }, { "url": "https://app.api.click.app/v1/assinatura_digital", "description": "Assinatura Digital" }, { "url": "https://app.api.click.app/v1/crm", "description": "CRM" } ], "tags": [ { "name": "Cadastros, produtos e serviços", "description": "Domínios do core da API pública: cadastros de pessoas, catálogo de produtos e serviços, tabelas auxiliares, usuários e lojas.", "x-modulo": "core" }, { "name": "Orçamentos, vendas e ordens de serviço", "description": "Pedidos em todas as formas: orçamento, venda, ordem de serviço, com situações e campos extras.", "x-modulo": "pedidos" }, { "name": "Estoque e compras", "description": "Compras, suas situações e campos extras, cotações, posição de estoque, inventário, lotes, movimentações, ajustes e transferências de estoque.", "x-modulo": "estoque" }, { "name": "Financeiro", "description": "Pagamentos, recebimentos, plano de contas, centros de custo, formas de pagamento e contas bancárias.", "x-modulo": "financeiro" }, { "name": "Notas fiscais", "description": "NF-e, NFC-e e NFS-e: cadastro, emissão e cancelamento.", "x-modulo": "fiscal" }, { "name": "MDF-e", "description": "Manifestos eletrônicos de documentos fiscais (tela MDF-e > Manifestos): listagem do período e o detalhe de cada manifesto. Só leitura — emitir, encerrar, cancelar e enviar por e-mail ficam na tela.", "x-modulo": "mdfe" }, { "name": "Contratos, locações e assinaturas", "description": "Contrato de serviço, locação e empréstimo de bens, assinatura recorrente — com situações e o recurso agregado que lista os quatro tipos.", "x-modulo": "contratos" }, { "name": "Assinatura Digital", "description": "Documentos eletrônicos, signatários, pastas e modelos. Diferente do restante da API pública: base própria e resposta sem envelope.", "x-modulo": "assinatura_digital" }, { "name": "CRM", "description": "Funis, prospectos, negócios e tarefas do CRM. Base própria (/crm/api) e envelope {success, meta, message, data}; paginação por page/limit/sort/direction na query (sort recebe o campo, ex.: nome); o meta.order da resposta devolve a ordenação aplicada — a enviada em sort/direction ou, sem elas, a padrão, que vem com o nome interno do campo (ex.: Funil.nome).", "x-modulo": "crm" }, { "name": "Atendimentos", "description": "Chamados de atendimento (tela Atendimentos > Chamados) com histórico de situações e mensagens, o relatório de chamados e os cadastros auxiliares (assuntos, formas de atendimento, situações e campos extras). Só leitura.", "x-modulo": "atendimentos" }, { "name": "Agenda", "description": "Compromissos da agenda (tela Agenda > Minha agenda) com histórico de situações, avisos e vínculos, a agenda de um dia, os próximos compromissos, as situações de compromisso e o relatório de compromissos. Só leitura.", "x-modulo": "agenda" } ], "paths": { "/clientes": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar clientes", "operationId": "core_clientes_listar", "x-modulo": "core", "x-recurso": "clientes", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome, razão social ou nome social (busca parcial)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código do cliente como aparece na tela (exato). Não é o id e não vem na resposta", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — trecho do telefone ou celular, com ou sem máscara", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato (trecho do e-mail não acha)", "schema": { "type": "string" } }, { "name": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = estrangeiro", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "1 = ativo, 0 = inativo; sem ele entram os dois (ativo também é aceito)", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço (ex.: MG)", "schema": { "type": "string" } }, { "name": "vendedor", "in": "query", "required": false, "description": "int — id do vendedor responsável (o id de /funcionarios). O nome do filtro aqui é vendedor: vendedor_id é ignorado. Só filtra se o usuário da chave puder ver clientes de outros vendedores", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia, inclusive (data de cadastro)", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados a partir deste dia (data da última alteração)", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados ANTES deste dia: o próprio dia fica de fora (compara com a meia-noite). Para incluir o dia, mande o dia seguinte", "schema": { "type": "string" } }, { "name": "resumido", "in": "query", "required": false, "description": "1 = cada item vem só com id, nome, tipo_pessoa, razao_social, cadastrado_em e modificado_em (resposta mais leve, sem contatos/endereços)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": [ "string", "null" ] }, "inscricao_estadual": { "type": [ "string", "null" ] }, "inscricao_municipal": { "type": [ "string", "null" ] }, "cpf": { "type": "string" }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "nome_tipo": { "type": "string" }, "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": [ "string", "null" ] }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_da_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "8", "tipo_pessoa": "PF", "nome": "Juao Carlos", "razao_social": null, "cnpj": null, "inscricao_estadual": null, "inscricao_municipal": null, "cpf": "792.727.480-54", "rg": null, "data_nascimento": "1988-03-30", "telefone": "(11) 3522-8899", "celular": "(96) 9 9194-9455", "fax": null, "email": "donis@itfast.net", "ativo": "1", "contatos": [ { "contato": { "tipo_id": "1307150", "nome_tipo": "Email", "nome": "Nome email", "contato": "contato@contato.com", "cargo": "Cargo", "observacao": "Observação" } } ], "enderecos": [ { "endereco": { "cep": "31260-210", "logradouro": "Rua Cassiano Campolina", "numero": "10", "complemento": null, "bairro": "Dona Clara", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Clientes/index", "x-periodo": { "data": "a data de cadastro do cliente (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Para achar UM cliente citado use nome (parcial), cpf_cnpj, telefone, email ou codigo; vários parecidos: mostre as opções. id e codigo são diferentes: codigo é o número da tela e não vem na resposta; os outros recursos pedem o id (cliente_id). Sem a permissão de ver clientes de outros vendedores, a chave só enxerga os clientes de que é o vendedor; com várias lojas e sem a permissão de ver clientes de outras lojas, só os das lojas dela — lista curta pode ser isso. Cada item já traz contatos, enderecos e atributos (campos extras; atributo_id aponta para /atributos_cadastros). meta.total_registros é o total do filtro: para contar use ele, nunca as linhas da página. Para listar ou contar por critério com totais, há também /relatorios/clientes.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do cliente (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.\n\n**Permissão exigida:** `Clientes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar clientes", "operationId": "core_clientes_cadastrar", "x-modulo": "core", "x-recurso": "clientes", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": [ "string", "null" ] }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": [ "string", "null" ] }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "9", "tipo_pessoa": "PF", "nome": "Otávio Juan Benício da Rosa", "razao_social": null, "cnpj": null, "inscricao_estadual": "", "inscricao_municipal": null, "cpf": "477.182.526-20", "rg": "49.660.357-7", "data_nascimento": "1945-05-16", "telefone": "(11) 2533-3532", "celular": "(96) 2641-9455", "fax": "", "email": "otaviojuanbeniciodarosa-99@agaxtur.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Kevin Otávio Luan Cavalcanti", "contato": "kevinotavioluancavalcanti-85@casabellavidros.com.br", "cargo": "Gerente", "observacao": "[-------]" } } ], "enderecos": [ { "endereco": { "cep": "31110-700", "logradouro": "Rua Itararé", "numero": "329", "complemento": "", "bairro": "Concórdia", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } }, "example": { "tipo_pessoa": "PF", "nome": "Otávio Juan Benício da Rosa", "razao_social": "", "cnpj": "", "inscricao_estadual": "", "inscricao_municipal": "", "cpf": "477.182.526-20", "rg": "49.660.357-7", "data_nascimento": "1945-05-16", "telefone": "(11) 2533-3532", "celular": "(96) 2641-9455", "fax": "", "email": "otaviojuanbeniciodarosa-99@agaxtur.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Kevin Otávio Luan Cavalcanti", "contato": "kevinotavioluancavalcanti-85@casabellavidros.com.br", "cargo": "Gerente", "observacao": "[-------]" } } ], "enderecos": [ { "endereco": { "cep": "31110-700", "logradouro": "Rua Itararé", "numero": "329", "complemento": "", "bairro": "Concórdia", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } } }, "/clientes/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar clientes", "operationId": "core_clientes_visualizar", "x-modulo": "core", "x-recurso": "clientes", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": [ "string", "null" ] }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": [ "string", "null" ] }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "nome_tipo": { "type": "string" }, "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "9", "tipo_pessoa": "PF", "nome": "Otávio Juan Benício da Rosa II", "razao_social": null, "cnpj": null, "inscricao_estadual": "", "inscricao_municipal": null, "cpf": "477.182.526-20", "rg": "49.660.357-7", "data_nascimento": "1945-05-16", "telefone": "(11) 2533-3532", "celular": "(96) 2641-9455", "fax": "", "email": "otaviojuanbeniciodarosa-99@agaxtur.com.br", "ativo": "1", "contatos": [ { "contato": { "tipo_id": "1307150", "nome_tipo": "Email", "nome": "Nome email", "contato": "contato@contato.com", "cargo": "Cargo", "observacao": "Observação" } } ], "enderecos": [ { "endereco": { "cep": "31110-700", "logradouro": "Rua Itararé", "numero": "329", "complemento": "", "bairro": "Concórdia", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Clientes/visualizar", "x-ia": "404 quando o id não existe ou é de outra empresa; 403 quando existe mas está fora do acesso do usuário da chave (cliente de outro vendedor ou de outra loja). Traz o cadastro com contatos, enderecos e atributos (campos extras). Não traz o codigo da tela nem a situação financeira: se ele deve, veja as contas a receber filtrando por cliente_id.", "description": "**Permissão exigida:** `Clientes/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar clientes", "operationId": "core_clientes_editar", "x-modulo": "core", "x-recurso": "clientes", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": [ "string", "null" ] }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": [ "string", "null" ] }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "9", "tipo_pessoa": "PF", "nome": "Otávio Juan Benício da Rosa II", "razao_social": null, "cnpj": null, "inscricao_estadual": "", "inscricao_municipal": null, "cpf": "477.182.526-20", "rg": "49.660.357-7", "data_nascimento": null, "telefone": "(11) 2533-3532", "celular": "(96) 2641-9455", "fax": "", "email": "otaviojuanbeniciodarosa-99@agaxtur.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Kevin Otávio Luan Cavalcanti", "contato": "kevinotavioluancavalcanti-85@casabellavidros.com.br", "cargo": "Gerente", "observacao": "[---[]----]" } } ], "enderecos": [ { "endereco": { "cep": "31110-700", "logradouro": "Rua Itararé", "numero": "329", "complemento": "CASA 01", "bairro": "Concórdia", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } }, "example": { "tipo_pessoa": "PF", "nome": "Otávio Juan Benício da Rosa", "razao_social": "", "cnpj": "", "inscricao_estadual": "", "inscricao_municipal": "", "cpf": "477.182.526-20", "rg": "49.660.357-7", "data_nascimento": "1945-05-16", "telefone": "(11) 2533-3532", "celular": "(96) 2641-9455", "fax": "", "email": "otaviojuanbeniciodarosa-99@agaxtur.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Kevin Otávio Luan Cavalcanti", "contato": "kevinotavioluancavalcanti-85@casabellavidros.com.br", "cargo": "Gerente", "observacao": "[---[]----]" } } ], "enderecos": [ { "endereco": { "cep": "31110-700", "logradouro": "Rua Itararé", "numero": "329", "complemento": "CASA 01", "bairro": "Concórdia", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar clientes", "operationId": "core_clientes_deletar", "x-modulo": "core", "x-recurso": "clientes", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Cliente excluido com sucesso" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/fornecedores": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar fornecedores", "operationId": "core_fornecedores_listar", "x-modulo": "core", "x-recurso": "fornecedores", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome ou razão social (busca parcial)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código do fornecedor como aparece na tela (exato). Não é o id e não vem na resposta", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — trecho do telefone ou celular, SÓ OS DÍGITOS: com máscara, ex. (11)9773-..., não acha", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato (trecho do e-mail não acha)", "schema": { "type": "string" } }, { "name": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = estrangeiro", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "1 = ativo, 0 = inativo; sem ele entram os dois (ativo também é aceito)", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço (ex.: SP)", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia, inclusive (data de cadastro)", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados a partir deste dia (data da última alteração)", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados ANTES deste dia: o próprio dia fica de fora (compara com a meia-noite). Para incluir o dia, mande o dia seguinte", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "object", "properties": [] }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_da_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "3", "tipo_pessoa": "PJ", "nome": "Samuel e Bento Corretores Associados ME", "razao_social": "Samuel e Bento Corretores Associados ME", "cnpj": "36.058.120/0001-97", "inscricao_estadual": "", "inscricao_municipal": "", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(11) 3625-2222", "celular": "", "email": "bento@samuelebento.com", "ativo": "1", "contatos": [], "enderecos": [ { "endereco": { "cep": "30310-480", "logradouro": "Rua Grajaú", "numero": "533", "complemento": "", "bairro": "Anchieta", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] }, { "id": "4", "tipo_pessoa": "PJ", "nome": "Erick Jacquin Telas Ltda", "razao_social": "Erick Jacquin Telas Ltda", "cnpj": "43.937.086/0001-96", "inscricao_estadual": "123951753", "inscricao_municipal": "", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(11) 2533-3532", "celular": "", "email": "compras@erickelarissatelasltda.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Luan Nicolas Costas", "contato": "luan@teste.com.br", "cargo": "Atendente", "observacao": "Contato de Luan" } } ], "enderecos": [ { "endereco": { "cep": "31565-090", "logradouro": "Rua Osvaldo Teixeira de Carvalho", "numero": "50", "complemento": "", "bairro": "Santa Branca", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fornecedores/index", "x-periodo": { "data": "a data de cadastro do fornecedor (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Fornecedor é da empresa inteira: não há recorte por loja nem por vendedor. Para achar UM fornecedor use nome (parcial, também pela razão social), cpf_cnpj, telefone (só dígitos), email ou codigo. id e codigo são diferentes: os outros recursos pedem o id (fornecedor_id). Cada item já traz contatos, enderecos e atributos (campos extras). meta.total_registros é o total do filtro: para contar use ele, nunca as linhas da página.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do fornecedor (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.\n\n**Permissão exigida:** `Fornecedores/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar fornecedores", "operationId": "core_fornecedores_cadastrar", "x-modulo": "core", "x-recurso": "fornecedores", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "4", "tipo_pessoa": "PJ", "nome": "Erick Jacquin Telas Ltda", "razao_social": "Erick Jacquin Telas Ltda", "cnpj": "43.937.086/0001-96", "inscricao_estadual": "123951753", "inscricao_municipal": "", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(11) 2533-3532", "celular": "", "email": "compras@erickelarissatelasltda.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Luan Nicolas Costas", "contato": "luan@teste.com.br", "cargo": "Atendente", "observacao": "Contato de Luan" } } ], "enderecos": [ { "endereco": { "cep": "31565-090", "logradouro": "Rua Osvaldo Teixeira de Carvalho", "numero": "50", "complemento": "", "bairro": "Santa Branca", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } }, "example": { "tipo_pessoa": "PJ", "nome": "Erick Jacquin Telas Ltda", "razao_social": "Erick Jacquin Telas Ltda", "cnpj": "43.937.086/0001-96", "inscricao_estadual": "123951753", "inscricao_municipal": "", "cpf": "", "rg": "", "data_nascimento": "", "telefone": "(11) 2533-3532", "celular": "", "fax": "", "email": "compras@erickelarissatelasltda.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Luan Nicolas Costas", "contato": "luan@teste.com.br", "cargo": "Atendente", "observacao": "Contato de Luan" } } ], "enderecos": [ { "endereco": { "cep": "31565-090", "logradouro": "Rua Osvaldo Teixeira de Carvalho", "numero": "50", "complemento": "", "bairro": "Santa Branca", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } } }, "/fornecedores/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar fornecedores", "operationId": "core_fornecedores_visualizar", "x-modulo": "core", "x-recurso": "fornecedores", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "4", "tipo_pessoa": "PJ", "nome": "Erick Jacquin Telas Ltda", "razao_social": "Erick Jacquin Telas Ltda", "cnpj": "43.937.086/0001-96", "inscricao_estadual": "123951753", "inscricao_municipal": "", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(11) 2533-3532", "celular": "", "email": "compras@erickelarissatelasltda.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Luan Nicolas Costas", "contato": "luan@teste.com.br", "cargo": "Atendente", "observacao": "Contato de Luan" } } ], "enderecos": [ { "endereco": { "cep": "31565-090", "logradouro": "Rua Osvaldo Teixeira de Carvalho", "numero": "50", "complemento": "", "bairro": "Santa Branca", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fornecedores/visualizar", "x-ia": "404 quando o id não existe ou é de outra empresa. Traz o cadastro com contatos, enderecos e atributos (campos extras); o codigo da tela não vem.", "description": "**Permissão exigida:** `Fornecedores/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar fornecedores", "operationId": "core_fornecedores_editar", "x-modulo": "core", "x-recurso": "fornecedores", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "4", "tipo_pessoa": "PJ", "nome": "Erick Jacquin Restaurante", "razao_social": "Erick Jacquin Restaurante", "cnpj": "43.937.086/0001-96", "inscricao_estadual": "123951753", "inscricao_municipal": "", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(11) 2533-3532", "celular": "", "email": "compras@erickelarissatelasltda.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Luan Nicolas Costas", "contato": "luan@teste.com.br", "cargo": "Atendente", "observacao": "Contato de Luan" } } ], "enderecos": [ { "endereco": { "cep": "31565-090", "logradouro": "Rua Osvaldo Teixeira de Carvalho", "numero": "50", "complemento": "", "bairro": "Santa Branca", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } }, "example": { "tipo_pessoa": "PJ", "nome": "Erick Jacquin Restaurante", "razao_social": "Erick Jacquin Restaurante", "cnpj": "43.937.086/0001-96", "inscricao_estadual": "123951753", "inscricao_municipal": "", "cpf": "", "rg": "", "data_nascimento": "", "telefone": "(11) 2533-3532", "celular": "", "fax": "", "email": "compras@erickelarissatelasltda.com.br", "ativo": "1", "contatos": [ { "contato": { "nome": "Luan Nicolas Costas", "contato": "luan@teste.com.br", "cargo": "Atendente", "observacao": "Contato de Luan" } } ], "enderecos": [ { "endereco": { "cep": "31565-090", "logradouro": "Rua Osvaldo Teixeira de Carvalho", "numero": "50", "complemento": "", "bairro": "Santa Branca", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar fornecedores", "operationId": "core_fornecedores_deletar", "x-modulo": "core", "x-recurso": "fornecedores", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Fornecedor removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/funcionarios": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar funcionários", "operationId": "core_funcionarios_listar", "x-modulo": "core", "x-recurso": "funcionarios", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome (busca parcial)", "schema": { "type": "string" } }, { "name": "cpf", "in": "query", "required": false, "description": "string — CPF, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — trecho do telefone ou de um dos celulares, com ou sem máscara", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço", "schema": { "type": "string" } }, { "name": "pAcesso", "in": "query", "required": false, "description": "1 = só quem acessa o sistema, 0 = só quem não acessa (o nome do parâmetro é esse mesmo). Sem a permissão de listar usuários, só vêm os que não acessam, com ou sem ele", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — funcionários com acesso a esta loja; sem ele, os da loja padrão da chave (não todas)", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia, inclusive (data de cadastro)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 5, "total_da_pagina": 5, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Ronei Marcos" }, { "id": "2", "nome": "Emerson Coelho" }, { "id": "3", "nome": "Pedro Henrique" }, { "id": "4", "nome": "Wesley Rosa" }, { "id": "5", "nome": "Linus Torvalds" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de cadastro do funcionário (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Funcionário é quem trabalha na empresa, com ou sem acesso ao sistema; o id é o mesmo de /usuarios e o que aparece como vendedor_id dos clientes. Sem a permissão de listar usuários, a chave só vê funcionários sem acesso ao sistema — lista curta pode ser isso. Não há filtro de situação nem de grupo aqui (ativo e grupo_id são ignorados): para grupo use /usuarios ou /relatorios/funcionarios. meta.total_registros é o total do filtro: para contar use ele, nunca as linhas da página.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do funcionário (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_cadastros": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar campos extras de cadastros", "operationId": "core_atributos_cadastros_listar", "x-modulo": "core", "x-recurso": "atributos_cadastros", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome do campo extra (busca parcial)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Registro", "tipo": "numeros", "modificado_em": "2025-01-21 00:58:11", "cadastrado_em": "2025-01-21 00:58:11" }, { "id": "2", "nome": "Campo Aux", "tipo": "texto_simples", "modificado_em": "2025-01-21 00:58:36", "cadastrado_em": "2025-01-21 00:58:36" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "São os campos extras de cadastro da empresa, os mesmos para clientes, fornecedores e funcionários. O conteúdo de cada cadastro vem em atributos do cliente/fornecedor/funcionário, com atributo_id apontando para cá. Vazio (\"Nenhum campo extra foi encontrado!\") quer dizer que a empresa não criou nenhum.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar campos extras de cadastros", "operationId": "core_atributos_cadastros_cadastrar", "x-modulo": "core", "x-recurso": "atributos_cadastros", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "empresa_id": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Registro", "tipo": "numeros", "empresa_id": "75798", "permitir_excluir": "1", "usuario_id": "131036", "nome_usuario": "Controle 1", "cadastrado_em": "2025-04-14 17:47:04", "modificado_em": "2025-04-14 17:47:04", "opcoes": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "opcoes": { "type": "object", "properties": [] } } }, "example": { "nome": "Registro", "tipo": "numeros", "opcoes": [] } } } } } }, "/atributos_cadastros/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar campos extras de cadastros", "operationId": "core_atributos_cadastros_visualizar", "x-modulo": "core", "x-recurso": "atributos_cadastros", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo": { "type": "string" }, "empresa_id": { "type": "string" }, "permitir_excluir": { "type": "string" }, "nome": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "tipo": "numeros", "empresa_id": "75798", "permitir_excluir": "1", "nome": "Documento", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar campos extras de cadastros", "operationId": "core_atributos_cadastros_editar", "x-modulo": "core", "x-recurso": "atributos_cadastros", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "empresa_id": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documentos", "tipo": "check_list", "empresa_id": "75798", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "RG" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Documentos", "tipo": "check_list", "opcoes": [ { "nome": "RG" }, { "nome": "CNH" } ] } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar campos extras de cadastros", "operationId": "core_atributos_cadastros_deletar", "x-modulo": "core", "x-recurso": "atributos_cadastros", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Campo extra removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/transportadoras": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar transportadoras", "operationId": "core_transportadoras_listar", "x-modulo": "core", "x-recurso": "transportadoras", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome ou razão social (busca parcial)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código da transportadora como aparece na tela (exato). Não é o id e não vem na resposta", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — trecho do telefone ou celular, com ou sem máscara", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = ativa, 0 = inativa; sem ele entram as duas. Aqui o filtro é ativo: situacao é ignorado", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço (ex.: MG)", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia, inclusive (data de cadastro)", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados a partir deste dia (data da última alteração)", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados ANTES deste dia: o próprio dia fica de fora (compara com a meia-noite). Para incluir o dia, mande o dia seguinte", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Transportadoras/index", "x-periodo": { "data": "a data de cadastro da transportadora (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Transportadora é da empresa inteira: não há recorte por loja. Situação: use ativo (situacao não filtra aqui). id e codigo são diferentes: os outros recursos pedem o id (transportadora_id). meta.total_registros é o total do filtro: para contar use ele, nunca as linhas da página.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro da transportadora (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.\n\n**Permissão exigida:** `Transportadoras/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar transportadoras", "operationId": "core_transportadoras_cadastrar", "x-modulo": "core", "x-recurso": "transportadoras", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "observacoes": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "6", "tipo_pessoa": "PJ", "nome": "Edson e Carlos Eduardo Limpeza", "razao_social": "Edson e Carlos Eduardo Limpeza ME", "cnpj": "22.359.529/0001-39", "inscricao_estadual": "472.736.113.437", "inscricao_municipal": "987415531", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(31) 2707-9510", "celular": "(31) 9 8874-95", "email": "producao@edsonecarloseduardolimpezame.com.br", "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "ativo": "1", "contatos": [ { "contato": { "nome": "Lavínia Analu Lorena Moura", "contato": "lavinia@limpeza.com.br", "cargo": "Diretor", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } }, { "contato": { "nome": "Agatha Bruna", "contato": "Agatha@limpeza.com.br", "cargo": "Diretor II", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } } ], "enderecos": [ { "endereco": { "cep": "31748-040", "logradouro": "Rua Aldemiro Fernandes Torres", "numero": "509", "complemento": "", "bairro": "Jaqueline", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "observacoes": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } }, "example": { "tipo_pessoa": "PJ", "nome": "Edson e Carlos Eduardo Limpeza", "razao_social": "Edson e Carlos Eduardo Limpeza ME", "cnpj": "22.359.529/0001-39", "inscricao_estadual": "472.736.113.437", "inscricao_municipal": "987415531", "cpf": "", "rg": "", "data_nascimento": "", "telefone": "(31) 2707-9510", "celular": "(31) 98874-9510", "email": "producao@edsonecarloseduardolimpezame.com.br", "observacoes": " Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "ativo": "1", "contatos": [ { "contato": { "nome": "Lavínia Analu Lorena Moura", "contato": "lavinia@limpeza.com.br", "cargo": "Diretor", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } }, { "contato": { "nome": "Agatha Bruna", "contato": "Agatha@limpeza.com.br", "cargo": "Diretor II", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } } ], "enderecos": [ { "endereco": { "cep": "31748-040", "logradouro": "Rua Aldemiro Fernandes Torres", "numero": "509", "complemento": "", "bairro": "Jaqueline", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } } }, "/transportadoras/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar transportadoras", "operationId": "core_transportadoras_visualizar", "x-modulo": "core", "x-recurso": "transportadoras", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "observacoes": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "6", "tipo_pessoa": "PJ", "nome": "Edson e Carlos Eduardo Limpeza", "razao_social": "Edson e Carlos Eduardo Limpeza ME", "cnpj": "22.359.529/0001-39", "inscricao_estadual": "472.736.113.437", "inscricao_municipal": "987415531", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(31) 2707-9510", "celular": "(31) 9 8874-95", "email": "producao@edsonecarloseduardolimpezame.com.br", "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "ativo": "1", "contatos": [ { "contato": { "nome": "Lavínia Analu Lorena Moura", "contato": "lavinia@limpeza.com.br", "cargo": "Diretor", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } }, { "contato": { "nome": "Agatha Bruna", "contato": "Agatha@limpeza.com.br", "cargo": "Diretor II", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } } ], "enderecos": [ { "endereco": { "cep": "31748-040", "logradouro": "Rua Aldemiro Fernandes Torres", "numero": "509", "complemento": "", "bairro": "Jaqueline", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Transportadoras/visualizar", "x-ia": "404 quando o id não existe ou é de outra empresa. Traz o cadastro com observacoes, contatos e enderecos.", "description": "**Permissão exigida:** `Transportadoras/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar transportadoras", "operationId": "core_transportadoras_editar", "x-modulo": "core", "x-recurso": "transportadoras", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "observacoes": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "6", "tipo_pessoa": "PJ", "nome": "Edson e Hudson Limpeza", "razao_social": "Edson e Hudson Limpeza ME", "cnpj": "22.359.529/0001-39", "inscricao_estadual": "472.736.113.437", "inscricao_municipal": "987415531", "cpf": null, "rg": null, "data_nascimento": null, "telefone": "(31) 2707-9510", "celular": "(31) 9 8874-95", "email": "producao@edsonecarloseduardolimpezame.com.br", "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "ativo": "1", "contatos": [ { "contato": { "nome": "Lavínia Analu Lorena Moura", "contato": "lavinia@limpeza.com.br", "cargo": "Diretor", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } }, { "contato": { "nome": "Agatha Bruna", "contato": "Agatha@limpeza.com.br", "cargo": "Diretor II", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } } ], "enderecos": [ { "endereco": { "cep": "31748-040", "logradouro": "Rua Aldemiro Fernandes Torres", "numero": "509", "complemento": "", "bairro": "Jaqueline", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "observacoes": { "type": "string" }, "ativo": { "type": "string" }, "contatos": { "type": "array", "items": { "type": "object", "properties": { "contato": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "cargo": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "enderecos": { "type": "array", "items": { "type": "object", "properties": { "endereco": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" } } } } } } } }, "example": { "tipo_pessoa": "PJ", "nome": "Edson e Hudson Limpeza", "razao_social": "Edson e Hudson Limpeza ME", "cnpj": "22.359.529/0001-39", "inscricao_estadual": "472.736.113.437", "inscricao_municipal": "987415531", "cpf": "", "rg": "", "data_nascimento": "", "telefone": "(31) 2707-9510", "celular": "(31) 9 8874-9510", "email": "producao@edsonecarloseduardolimpezame.com.br", "observacoes": " Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "ativo": "1", "contatos": [ { "contato": { "nome": "Lavínia Analu Lorena Moura", "contato": "lavinia@limpeza.com.br", "cargo": "Diretor", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } }, { "contato": { "nome": "Agatha Bruna", "contato": "Agatha@limpeza.com.br", "cargo": "Diretor II", "observacao": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." } } ], "enderecos": [ { "endereco": { "cep": "31748-040", "logradouro": "Rua Aldemiro Fernandes Torres", "numero": "509", "complemento": "", "bairro": "Jaqueline", "nome_cidade": "Belo Horizonte", "estado": "MG" } } ] } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar transportadoras", "operationId": "core_transportadoras_deletar", "x-modulo": "core", "x-recurso": "transportadoras", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Transportadora removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/tipos_contatos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar tipos de contatos", "operationId": "core_tipos_contatos_listar", "x-modulo": "core", "x-recurso": "tipos_contatos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome do tipo (busca parcial)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 3, "total_da_pagina": 3, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "109", "nome": "E-mail" }, { "id": "110", "nome": "Facebook" }, { "id": "111", "nome": "Skype" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Os tipos de contato (Telefone, E-mail, WhatsApp...) cadastrados pela empresa; o id é o tipo_id dos contatos de clientes.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/tipos_enderecos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar tipos de endereços", "operationId": "core_tipos_enderecos_listar", "x-modulo": "core", "x-recurso": "tipos_enderecos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome do tipo (busca parcial)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 3, "total_da_pagina": 3, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "68", "nome": "Comercial" }, { "id": "69", "nome": "Residencial" }, { "id": "70", "nome": "Entrega" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Os tipos de endereço (Comercial, Residencial, Entrega...) cadastrados pela empresa; o id é o tipo_id de enderecos de clientes.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/estados": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar estados", "operationId": "core_estados_listar", "x-modulo": "core", "x-recurso": "estados", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome do estado (busca parcial)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": "integer" }, "proxima_url": { "type": "string" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 27, "total_da_pagina": 20, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": 2, "proxima_url": "/api/estados?pagina=2" }, "data": [ { "id": "1", "codigo": "12", "nome": "Acre", "sigla": "AC" }, { "id": "2", "codigo": "27", "nome": "Alagoas", "sigla": "AL" }, { "id": "4", "codigo": "16", "nome": "Amapá", "sigla": "AP" }, { "id": "3", "codigo": "13", "nome": "Amazonas", "sigla": "AM" }, { "id": "5", "codigo": "29", "nome": "Bahia", "sigla": "BA" }, { "id": "6", "codigo": "23", "nome": "Ceará", "sigla": "CE" }, { "id": "7", "codigo": "53", "nome": "Distrito Federal", "sigla": "DF" }, { "id": "8", "codigo": "32", "nome": "Espírito Santo", "sigla": "ES" }, { "id": "9", "codigo": "52", "nome": "Goiás", "sigla": "GO" }, { "id": "10", "codigo": "21", "nome": "Maranhão", "sigla": "MA" }, { "id": "13", "codigo": "51", "nome": "Mato Grosso", "sigla": "MT" }, { "id": "12", "codigo": "50", "nome": "Mato Grosso Do Sul", "sigla": "MS" }, { "id": "11", "codigo": "31", "nome": "Minas Gerais", "sigla": "MG" }, { "id": "14", "codigo": "15", "nome": "Pará", "sigla": "PA" }, { "id": "15", "codigo": "25", "nome": "Paraíba", "sigla": "PB" }, { "id": "18", "codigo": "41", "nome": "Paraná", "sigla": "PR" }, { "id": "16", "codigo": "26", "nome": "Pernambuco", "sigla": "PE" }, { "id": "17", "codigo": "22", "nome": "Piauí", "sigla": "PI" }, { "id": "19", "codigo": "33", "nome": "Rio De Janeiro", "sigla": "RJ" }, { "id": "20", "codigo": "24", "nome": "Rio Grande Do Norte", "sigla": "RN" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "27 estados. id é o que /cidades pede em estado_id; codigo é o código IBGE da UF e sigla é a UF (ex.: MG). Os filtros estado dos cadastros usam a sigla, não o id.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/cidades": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar cidades", "operationId": "core_cidades_listar", "x-modulo": "core", "x-recurso": "cidades", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome da cidade (busca parcial)", "schema": { "type": "string" } }, { "name": "estado_id", "in": "query", "required": false, "description": "int — id do estado em /estados (não é a UF nem o código IBGE; MG, por exemplo, é 11)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código IBGE do município (7 dígitos, exato)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": "integer" }, "url_anterior": { "type": "string" }, "proxima_pagina": { "type": "integer" }, "proxima_url": { "type": "string" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 79, "total_da_pagina": 20, "pagina_atual": 2, "limite_por_pagina": 20, "pagina_anterior": 1, "url_anterior": "/api/cidades?estado=12&pagina=1", "proxima_pagina": 3, "proxima_url": "/api/cidades?estado=12&pagina=3" }, "data": [ { "id": "2219", "codigo": "5002803", "nome": "Caracol" }, { "id": "2220", "codigo": "5002902", "nome": "Cassilândia" }, { "id": "2221", "codigo": "5002951", "nome": "Chapadão do Sul" }, { "id": "2222", "codigo": "5003108", "nome": "Corguinho" }, { "id": "2223", "codigo": "5003157", "nome": "Coronel Sapucaia" }, { "id": "2224", "codigo": "5003207", "nome": "Corumbá" }, { "id": "2225", "codigo": "5003256", "nome": "Costa Rica" }, { "id": "2226", "codigo": "5003306", "nome": "Coxim" }, { "id": "2227", "codigo": "5003454", "nome": "Deodápolis" }, { "id": "2228", "codigo": "5003488", "nome": "Dois Irmãos do Buriti" }, { "id": "2229", "codigo": "5003504", "nome": "Douradina" }, { "id": "2230", "codigo": "5003702", "nome": "Dourados" }, { "id": "2231", "codigo": "5003751", "nome": "Eldorado" }, { "id": "2232", "codigo": "5003801", "nome": "Fátima do Sul" }, { "id": "2233", "codigo": "5003900", "nome": "Figueirão" }, { "id": "2234", "codigo": "5004007", "nome": "Glória de Dourados" }, { "id": "2235", "codigo": "5004106", "nome": "Guia Lopes da Laguna" }, { "id": "2236", "codigo": "5004304", "nome": "Iguatemi" }, { "id": "2237", "codigo": "5004403", "nome": "Inocência" }, { "id": "2238", "codigo": "5004502", "nome": "Itaporã" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Use para achar o cidade_id que os filtros de clientes, fornecedores e transportadoras pedem. A resposta traz id, codigo (IBGE) e nome, sem a UF: nomes se repetem entre estados, então filtre também por estado_id. São 5.587 cidades: sempre filtre por nome.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/produtos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar produtos", "operationId": "core_produtos_listar", "x-modulo": "core", "x-recurso": "produtos", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — loja do estoque e dos valores; sem ele, a loja da chave (a matriz, se a chave não fixa loja). Uma loja por consulta", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome do produto: todas as palavras, em qualquer ordem (busca parcial)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código interno ou código de barras do produto (parcial); o código da variação só exato", "schema": { "type": "string" } }, { "name": "busca", "in": "query", "required": false, "description": "string — nome, código interno ou código de barras de uma vez (código de barras exato)", "schema": { "type": "string" } }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de produtos, já com os subgrupos; SG = só os produtos sem grupo — ids em `/grupos_produtos`", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — produtos ligados a este fornecedor — ids em `/fornecedores`", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "situação do ESTOQUE na loja (só produtos que movimentam estoque): 1 = sem estoque (zero ou negativo), 2 = com estoque, 3 = no mínimo ou abaixo, 4 = no máximo ou acima (3 e 4 só os que têm mínimo/máximo preenchido)", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — só os cadastros alterados a partir deste dia", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados até este dia, EXCLUSIVE: compara com o início do dia, então para incluir o dia mande o dia seguinte", "schema": { "type": "string" } }, { "name": "atributo", "in": "query", "required": false, "description": "atributo[]=texto — produtos com esse conteúdo no campo extra (ex.: atributo[326048]=azul) — ids em `/atributos_produtos`", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "codigo_interno": { "type": "string" }, "codigo_barra": { "type": "string" }, "possui_variacao": { "type": "string" }, "possui_composicao": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "peso": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" }, "comprimento": { "type": "string" }, "ativo": { "type": "string" }, "grupo_id": { "type": "string" }, "nome_grupo": { "type": "string" }, "descricao": { "type": "string" }, "estoque": { "type": "integer" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "valores": { "type": "array", "items": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "nome_tipo": { "type": "string" }, "lucro_utilizado": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" } } } }, "variacoes": { "type": "array", "items": { "type": "object", "properties": { "variacao": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "estoque": { "type": "string" }, "valores": { "type": "array", "items": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "nome_tipo": { "type": "string" }, "lucro_utilizado": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" } } } } } } } } }, "fiscal": { "type": "object", "properties": { "ncm": { "type": "string" }, "cest": { "type": "string" }, "peso_liquido": { "type": [ "string", "null" ] }, "peso_bruto": { "type": [ "string", "null" ] }, "valor_aproximado_tributos": { "type": [ "string", "null" ] }, "valor_fixo_pis": { "type": [ "string", "null" ] }, "valor_fixo_pis_st": { "type": [ "string", "null" ] }, "valor_fixo_confins": { "type": [ "string", "null" ] }, "valor_fixo_confins_st": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "320", "nome": "Blusão Masc Moletom", "codigo_interno": "0222", "codigo_barra": "2031754031703", "possui_variacao": "1", "possui_composicao": "0", "movimenta_estoque": "1", "peso": "0.000", "largura": "0.000", "altura": "0.000", "comprimento": "0.000", "ativo": "1", "grupo_id": "803218", "nome_grupo": "Eletrônicos", "descricao": "", "estoque": 60, "valor_custo": "80.0000", "valor_venda": "120.0000", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "80.0000", "valor_venda": "92.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "80.0000", "valor_venda": "104.0000" } ], "variacoes": [ { "variacao": { "id": "478", "nome": "Creme", "estoque": "10.00", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "41.18", "valor_custo": "85.0000", "valor_venda": "120.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "41.18", "valor_custo": "85.0000", "valor_venda": "120.0000" } ] } }, { "variacao": { "id": "480", "nome": "Marrom", "estoque": "20.00", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "80.0000", "valor_venda": "92.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "80.0000", "valor_venda": "104.0000" } ] } }, { "variacao": { "id": "482", "nome": "Azul Escuro", "estoque": "30.00", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "80.0000", "valor_venda": "92.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "80.0000", "valor_venda": "104.0000" } ] } } ], "fiscal": { "ncm": "", "cest": "", "peso_liquido": null, "peso_bruto": null, "valor_aproximado_tributos": null, "valor_fixo_pis": null, "valor_fixo_pis_st": null, "valor_fixo_confins": null, "valor_fixo_confins_st": null } }, { "id": "319", "nome": "Smart TV 4K LED 50", "codigo_interno": "011111", "codigo_barra": "2086871760609", "possui_variacao": "0", "possui_composicao": "0", "movimenta_estoque": "1", "peso": "0.000", "largura": "0.000", "altura": "0.000", "comprimento": "0.000", "ativo": "1", "grupo_id": "803218", "nome_grupo": "Eletrônicos", "descricao": "", "estoque": 10, "valor_custo": "1500.2000", "valor_venda": "1725.2300", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "1500.2000", "valor_venda": "1725.2300" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "1500.2000", "valor_venda": "1950.2600" } ], "variacoes": [ { "variacao": { "id": "476", "nome": "", "estoque": "10.00", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "1500.2000", "valor_venda": "1725.2300" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "1500.2000", "valor_venda": "1950.2600" } ] } } ], "fiscal": { "ncm": "85044060", "cest": "", "peso_liquido": "20.000", "peso_bruto": "20.000", "valor_aproximado_tributos": null, "valor_fixo_pis": null, "valor_fixo_pis_st": null, "valor_fixo_confins": null, "valor_fixo_confins_st": null } } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Catálogo de produtos (cadastro), do mais novo para o mais antigo. Vale uma loja por consulta: sem loja_id, a da chave — estoque e valores são dessa loja; para outra loja passe loja_id e diga de qual loja é o número. estoque é a soma das variações na loja. valores traz o preço em cada tabela de preço (tipo_id/nome_tipo, de /tipos_valores_produtos); valor_venda da raiz é só o da primeira tabela e, em produto com variação de preço próprio, o da última variação — para preço por variação use variacoes[].variacao.valores. Para achar um produto citado use nome ou codigo (busca procura nos dois). Não há filtro por marca nem por faixa de preço aqui: marca_id e valor_inicio/valor_fim são ignorados. Para \"o mais caro/barato\" não use ordenacao=valor_venda (ordena por um campo interno que pode não bater com o preço mostrado): compare valor_venda das linhas. Para contar, use meta.total_registros. O que foi vendido e a movimentação do estoque estão nos relatórios de produtos vendidos e de estoque.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar produtos", "operationId": "core_produtos_cadastrar", "x-modulo": "core", "x-recurso": "produtos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `nome`, `codigo_interno`, `valor_custo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "codigo_interno": { "type": "string" }, "codigo_barra": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" }, "comprimento": { "type": "string" }, "ativo": { "type": "string" }, "grupo_id": { "type": "string" }, "nome_grupo": { "type": "string" }, "descricao": { "type": "string" }, "estoque": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "ncm": { "type": "string" }, "cest": { "type": "string" }, "peso_liquido": { "type": "string" }, "peso_bruto": { "type": "string" }, "valor_aproximado_tributos": { "type": "string" }, "valor_fixo_pis": { "type": "string" }, "valor_fixo_pis_st": { "type": "string" }, "valor_fixo_confins": { "type": "string" }, "valor_fixo_confins_st": { "type": "string" }, "fornecedores": { "type": "array", "items": { "type": "object", "properties": { "fornecedor_id": { "type": "string" } } } } } }, "example": { "nome": "Televisão Smart TV - LED 32", "codigo_interno": "32355564390", "codigo_barra": "98412200100", "largura": "80", "altura": "50", "comprimento": "8", "ativo": "1", "grupo_id": "803218", "nome_grupo": "Eletrônicos", "descricao": "Televisão Smart TV com wi-fi 32 Polegadas", "estoque": "10", "valor_custo": "700.62", "valor_venda": "850.99", "ncm": "11010010", "cest": "0100200", "peso_liquido": "1,000", "peso_bruto": "1,550", "valor_aproximado_tributos": "1,00", "valor_fixo_pis": "1,0000", "valor_fixo_pis_st": "3.00", "valor_fixo_confins": "4.00", "valor_fixo_confins_st": "6.00", "fornecedores": [ { "fornecedor_id": "241" }, { "fornecedor_id": "169" } ] } } } } } }, "/produtos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar produtos", "operationId": "core_produtos_visualizar", "x-modulo": "core", "x-recurso": "produtos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — loja do estoque e dos valores; sem ele, a loja da chave", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "codigo_interno": { "type": "string" }, "codigo_barra": { "type": "string" }, "possui_variacao": { "type": "string" }, "possui_composicao": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "peso": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" }, "comprimento": { "type": "string" }, "ativo": { "type": "string" }, "grupo_id": { "type": "string" }, "nome_grupo": { "type": "string" }, "descricao": { "type": "string" }, "estoque": { "type": "integer" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "valores": { "type": "array", "items": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "nome_tipo": { "type": "string" }, "lucro_utilizado": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" } } } }, "variacoes": { "type": "array", "items": { "type": "object", "properties": { "variacao": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "estoque": { "type": "string" }, "valores": { "type": "array", "items": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "nome_tipo": { "type": "string" }, "lucro_utilizado": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" } } } } } } } } }, "fiscal": { "type": "object", "properties": { "ncm": { "type": "string" }, "cest": { "type": "string" }, "peso_liquido": { "type": [ "string", "null" ] }, "peso_bruto": { "type": [ "string", "null" ] }, "valor_aproximado_tributos": { "type": [ "string", "null" ] }, "valor_fixo_pis": { "type": [ "string", "null" ] }, "valor_fixo_pis_st": { "type": [ "string", "null" ] }, "valor_fixo_confins": { "type": [ "string", "null" ] }, "valor_fixo_confins_st": { "type": [ "string", "null" ] } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "320", "nome": "Blusão Masc Moletom", "codigo_interno": "0222", "codigo_barra": "2031754031703", "possui_variacao": "1", "possui_composicao": "0", "movimenta_estoque": "1", "peso": "0.000", "largura": "0.000", "altura": "0.000", "comprimento": "0.000", "ativo": "1", "grupo_id": "803218", "nome_grupo": "Eletrônicos", "descricao": "", "estoque": 60, "valor_custo": "80.0000", "valor_venda": "120.0000", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "80.0000", "valor_venda": "92.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "80.0000", "valor_venda": "104.0000" } ], "variacoes": [ { "variacao": { "id": "478", "nome": "Creme", "estoque": "10.00", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "41.18", "valor_custo": "85.0000", "valor_venda": "120.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "41.18", "valor_custo": "85.0000", "valor_venda": "120.0000" } ] } }, { "variacao": { "id": "480", "nome": "Marrom", "estoque": "20.00", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "80.0000", "valor_venda": "92.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "80.0000", "valor_venda": "104.0000" } ] } }, { "variacao": { "id": "482", "nome": "Azul Escuro", "estoque": "30.00", "valores": [ { "tipo_id": "90864", "nome_tipo": "Varejo", "lucro_utilizado": "15.00", "valor_custo": "80.0000", "valor_venda": "92.0000" }, { "tipo_id": "90872", "nome_tipo": "Atacado", "lucro_utilizado": "30.00", "valor_custo": "80.0000", "valor_venda": "104.0000" } ] } } ], "fiscal": { "ncm": "", "cest": "", "peso_liquido": null, "peso_bruto": null, "valor_aproximado_tributos": null, "valor_fixo_pis": null, "valor_fixo_pis_st": null, "valor_fixo_confins": null, "valor_fixo_confins_st": null } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Um produto por id: os mesmos campos da listagem (valores por tabela, variações, estoque da loja, fiscal, fotos e campos extras em atributos). Produto que não existe ou é de outra empresa é 404.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar produtos", "operationId": "core_produtos_editar", "x-modulo": "core", "x-recurso": "produtos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "codigo_interno": { "type": "string" }, "codigo_barra": { "type": "string" }, "possui_variacao": { "type": "string" }, "possui_composicao": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "peso": { "type": [ "string", "null" ] }, "largura": { "type": "string" }, "altura": { "type": "string" }, "comprimento": { "type": "string" }, "ativo": { "type": "string" }, "grupo_id": { "type": "string" }, "nome_grupo": { "type": "string" }, "descricao": { "type": "string" }, "estoque": { "type": "integer" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "valores": { "type": "array", "items": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "nome_tipo": { "type": "string" }, "lucro_utilizado": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" } } } }, "variacoes": { "type": "array", "items": { "type": "object", "properties": { "variacao": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "estoque": { "type": "string" } } } } } }, "fiscal": { "type": "object", "properties": { "ncm": { "type": "string" }, "cest": { "type": "string" }, "peso_liquido": { "type": "string" }, "peso_bruto": { "type": "string" }, "valor_aproximado_tributos": { "type": "string" }, "valor_fixo_pis": { "type": "string" }, "valor_fixo_pis_st": { "type": "string" }, "valor_fixo_confins": { "type": "string" }, "valor_fixo_confins_st": { "type": "string" } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "22", "nome": "Televisão Smart TV - Plasma 52 P", "codigo_interno": "97845678", "codigo_barra": "8995874587451", "possui_variacao": "0", "possui_composicao": "0", "movimenta_estoque": "1", "peso": null, "largura": "80.000", "altura": "50.000", "comprimento": "8.000", "ativo": "1", "grupo_id": "803218", "nome_grupo": "Eletrônicos", "descricao": "Televisão Smart TV Plasma com wi-fi 52 Polegadas", "estoque": 10, "valor_custo": "12.0000", "valor_venda": "10.00", "cadastrado_em": "2024-03-12 14:30:36", "modificado_em": "2024-11-01 11:46:10", "valores": [ { "tipo_id": "90937", "nome_tipo": "valor de venda novo", "lucro_utilizado": "0", "valor_custo": "12", "valor_venda": "10.00" }, { "tipo_id": "90938", "nome_tipo": "novo valor", "lucro_utilizado": "0", "valor_custo": "12", "valor_venda": "18.00" } ], "variacoes": [ { "variacao": { "id": "232", "nome": "", "estoque": "10.00" } } ], "fiscal": { "ncm": "11010010", "cest": "0100200", "peso_liquido": "1.000", "peso_bruto": "1.000", "valor_aproximado_tributos": "1.00", "valor_fixo_pis": "1.00", "valor_fixo_pis_st": "3.00", "valor_fixo_confins": "4.00", "valor_fixo_confins_st": "6.00" } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `nome`, `codigo_interno`, `valor_custo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "codigo_interno": { "type": "string" }, "codigo_barra": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" }, "comprimento": { "type": "string" }, "ativo": { "type": "string" }, "grupo_id": { "type": "string" }, "nome_grupo": { "type": "string" }, "descricao": { "type": "string" }, "estoque": { "type": "string" }, "valor_custo": { "type": "integer" }, "valores": { "type": "array", "items": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "valor_venda": { "type": "integer" } } } }, "ncm": { "type": "string" }, "cest": { "type": "string" }, "peso_liquido": { "type": "string" }, "peso_bruto": { "type": "string" }, "valor_aproximado_tributos": { "type": "integer" }, "valor_fixo_pis": { "type": "string" }, "valor_fixo_pis_st": { "type": "integer" }, "valor_fixo_confins": { "type": "integer" }, "valor_fixo_confins_st": { "type": "integer" } } }, "example": { "nome": "Televisão Smart TV - Plasma 52 P", "codigo_interno": "97845678", "codigo_barra": "8995874587451", "largura": "80", "altura": "50", "comprimento": "8", "ativo": "1", "grupo_id": "803218", "nome_grupo": "Eletrônicos", "descricao": "Televisão Smart TV Plasma com wi-fi 52 Polegadas", "estoque": "10", "valor_custo": 12, "valores": [ { "tipo_id": "90937", "valor_venda": 10 }, { "tipo_id": "90938", "valor_venda": 18 } ], "ncm": "11010010", "cest": "0100200", "peso_liquido": "1,000", "peso_bruto": "1,550", "valor_aproximado_tributos": 1, "valor_fixo_pis": "1,0000", "valor_fixo_pis_st": 3, "valor_fixo_confins": 4, "valor_fixo_confins_st": 6 } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar produtos", "operationId": "core_produtos_deletar", "x-modulo": "core", "x-recurso": "produtos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/produtos/{id}/historico_valores": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Histórico do preço de venda de produtos", "operationId": "core_produtos_historico_valores", "x-modulo": "core", "x-recurso": "produtos", "x-operacao": "historico_valores", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da alteração do preço); junto com data_fim", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — só as alterações dessa loja; sem ele, todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": [ "string", "null" ] }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" } } }, "data": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "possui_variacao": { "type": "boolean" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "string" }, "loja_id": { "type": "string" }, "loja": { "type": "string" }, "variacao_id": { "type": [ "string", "null" ] }, "variacao": { "type": [ "string", "null" ] }, "tipo_valor_id": { "type": "string" }, "tipo_valor": { "type": "string" }, "valor_venda": { "type": "integer" }, "origem": { "type": "string" }, "descricao": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": null, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 5, "pagina": 1, "limite": 3, "total_paginas": 2 }, "data": { "produto": { "id": "31998", "nome": "Coca cola", "possui_variacao": false }, "itens": [ { "id": "36356", "data": "2026-09-21 10:00:46", "loja_id": "65", "loja": "Master", "variacao_id": null, "variacao": null, "tipo_valor_id": "91657", "tipo_valor": "Padrão", "valor_venda": 15, "origem": "Usuário", "descricao": null }, { "id": "36355", "data": "2026-09-21 10:00:46", "loja_id": "80773", "loja": "Conta Integrada", "variacao_id": null, "variacao": null, "tipo_valor_id": "91657", "tipo_valor": "Padrão", "valor_venda": 15, "origem": "Usuário", "descricao": null }, { "id": "36354", "data": "2026-09-21 10:00:46", "loja_id": "80764", "loja": "11", "variacao_id": null, "variacao": null, "tipo_valor_id": "91657", "tipo_valor": "Padrão", "valor_venda": 15, "origem": "Usuário", "descricao": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Produtos/index", "x-periodo": { "data": "a data da alteração do preço", "padrao": "não filtra (histórico inteiro)", "teto_meses": 12 }, "x-ia": "Use para \"quando o preço deste produto mudou\" ou \"qual era o preço em tal data\": valor_venda é o preço que passou a valer naquela data, por loja, variação e tipo de valor — uma mesma alteração aparece uma vez por loja. data.itens vazio quer dizer que o preço nunca foi alterado (ou não no período). O custo não entra; o preço atual está em GET /produtos/{id}.", "description": "Cada alteração do preço de venda do produto: data, loja, variação (quando o produto tem grade), tipo de valor (tabela de preço) e o valor que passou a valer, da mais recente para a mais antiga. É a tela Histórico de valores, aberta pela listagem de produtos. Produto inexistente, de outra empresa ou fora das lojas do usuário da chave é 404.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da alteração do preço. Sem elas: não filtra (histórico inteiro). Máximo: 12 meses.\n\n**Permissão exigida:** `Produtos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/grupos_produtos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar grupos de produtos", "operationId": "core_grupos_produtos_listar", "x-modulo": "core", "x-recurso": "grupos_produtos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_da_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "801358", "nome": "Celulares" }, { "id": "801356", "nome": "Eletrônicos" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Grupos (categorias) do catálogo de produtos, da empresa toda. grupo_pai_id preenchido = subgrupo daquele grupo. Para listar os produtos de um grupo use /produtos?grupo_id=, que já inclui os subgrupos; grupo_id=SG traz os produtos sem grupo.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/grupos_produtos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar grupos de produtos", "operationId": "core_grupos_produtos_visualizar", "x-modulo": "core", "x-recurso": "grupos_produtos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Um grupo por id. Grupo que não existe ou é de outra empresa é 404.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_produtos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar campos extras de produtos", "operationId": "core_atributos_produtos_listar", "x-modulo": "core", "x-recurso": "atributos_produtos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Registro", "tipo": "numeros", "modificado_em": "2025-01-21 00:58:11", "cadastrado_em": "2025-01-21 00:58:11" }, { "id": "2", "nome": "Documentos", "tipo": "texto_simples", "modificado_em": "2025-01-21 00:58:36", "cadastrado_em": "2025-01-21 00:58:36" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Campos extras do cadastro de produtos e serviços (os mesmos para os dois), da empresa toda. obrigatorio 1 = o cadastro exige o campo. Para achar produtos ou serviços por um campo extra use atributo[]=texto em /produtos ou /servicos; o valor de cada produto vem em atributos.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar campos extras de produtos", "operationId": "core_atributos_produtos_cadastrar", "x-modulo": "core", "x-recurso": "atributos_produtos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Arquivos", "tipo": "check_list", "cadastrado_em": "2025-04-14 17:47:04", "modificado_em": "2025-04-14 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "RG" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Arquivos", "tipo": "check_list", "opcoes": [ { "nome": "RG" }, { "nome": "CNH" } ] } } } } } }, "/atributos_produtos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar campos extras de produtos", "operationId": "core_atributos_produtos_visualizar", "x-modulo": "core", "x-recurso": "atributos_produtos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo": { "type": "string" }, "nome": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "tipo": "numeros", "nome": "Registro", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar campos extras de produtos", "operationId": "core_atributos_produtos_editar", "x-modulo": "core", "x-recurso": "atributos_produtos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documentos", "tipo": "check_list", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "RG" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Documentos", "tipo": "check_list", "opcoes": [ { "nome": "RG" }, { "nome": "CNH" } ] } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar campos extras de produtos", "operationId": "core_atributos_produtos_deletar", "x-modulo": "core", "x-recurso": "atributos_produtos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Campo extra removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/servicos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar serviços", "operationId": "core_servicos_listar", "x-modulo": "core", "x-recurso": "servicos", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — só os serviços dessa loja; sem ele, a loja da chave (a matriz, se a chave não fixa loja)", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome (a frase inteira, na ordem: \"criação sites\" não acha \"Criação de sites\")", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código do serviço, exato", "schema": { "type": "string" } }, { "name": "busca", "in": "query", "required": false, "description": "string — trecho do nome ou do código", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "número (1234.50) — preço de venda a partir de", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "número (1234.50) — preço de venda até", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — só os cadastros alterados a partir deste dia", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados até este dia, EXCLUSIVE (compara com o início do dia): para incluir o dia mande o dia seguinte", "schema": { "type": "string" } }, { "name": "atributo", "in": "query", "required": false, "description": "atributo[]=texto — serviços com esse trecho no campo extra — ids em `/atributos_produtos`", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "valor_venda": { "type": "string" }, "observacoes": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_da_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "19", "codigo": "2086340109007", "nome": "Formatação de computador", "valor_venda": "12.00", "observacoes": "" }, { "id": "44", "codigo": "19841915891", "nome": "Manutenção de celular", "valor_venda": "50.00", "observacoes": "Manutenção em geral" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Catálogo de serviços (o que a empresa vende como serviço), em ordem de nome, com o preço de venda em valor_venda. Não é o que foi vendido: para isso use o relatório de serviços vendidos. Não há filtro por grupo de serviço (grupo_id é ignorado). Nome curto ou com palavras fora de ordem: use busca com uma palavra só. Para contar, use meta.total_registros.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar serviços", "operationId": "core_servicos_cadastrar", "x-modulo": "core", "x-recurso": "servicos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "valor_venda": { "type": "string" }, "observacoes": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "44", "codigo": "19841915891", "nome": "Manutenção de celular", "valor_venda": "50.00", "observacoes": "Manutenção em geral" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `nome`, `codigo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "valor_venda": { "type": "integer" }, "observacoes": { "type": "string" } } }, "example": { "codigo": "19841915891", "nome": "Manutenção de celular", "valor_venda": 50, "observacoes": "Manutenção em geral" } } } } } }, "/servicos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar serviços", "operationId": "core_servicos_visualizar", "x-modulo": "core", "x-recurso": "servicos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "valor_venda": { "type": "string" }, "observacoes": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "44", "codigo": "19841915891", "nome": "Manutenção de celulares", "valor_venda": "50.00", "observacoes": "Manutenção em geral, inclusive software" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar serviços", "operationId": "core_servicos_editar", "x-modulo": "core", "x-recurso": "servicos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "valor_venda": { "type": "string" }, "observacoes": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "44", "codigo": "19841915891", "nome": "Manutenção de celulares", "valor_venda": "50.00", "observacoes": "Manutenção em geral, inclusive software" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `nome`, `codigo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "valor_venda": { "type": "integer" }, "observacoes": { "type": "string" } } }, "example": { "codigo": "19841915891", "nome": "Manutenção de celulares", "valor_venda": 50, "observacoes": "Manutenção em geral, inclusive software" } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar serviços", "operationId": "core_servicos_deletar", "x-modulo": "core", "x-recurso": "servicos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Serviço removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/usuarios": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Listar usuários", "operationId": "assinatura_digital_usuarios_listar", "x-modulo": "assinatura_digital", "x-recurso": "usuarios", "x-operacao": "listar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": [ "string", "null" ] }, "sexo": { "type": "string" }, "grupo_id": { "type": "string" }, "email": { "type": "string" }, "observacoes": { "type": "string" }, "telefone": { "type": "string" }, "celular1": { "type": "string" }, "celular2": { "type": "string" }, "hora_entrada": { "type": "string" }, "hora_almoco_entrada": { "type": "string" }, "hora_almoco_saida": { "type": "string" }, "hora_saida": { "type": "string" }, "ativo": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "João da Silva", "cpf": "", "rg": "", "data_nascimento": null, "sexo": "", "grupo_id": "1", "email": "joao@site.com.br", "observacoes": "", "telefone": "", "celular1": "", "celular2": "", "hora_entrada": "00:00", "hora_almoco_entrada": "12:00", "hora_almoco_saida": "12:00", "hora_saida": "23:59", "ativo": "1" }, { "id": "2", "nome": "Maria", "cpf": "", "rg": "", "data_nascimento": null, "sexo": "", "grupo_id": "27", "email": "maria@site.com.br", "observacoes": "", "telefone": "", "celular1": "", "celular2": "", "hora_entrada": "00:00", "hora_almoco_entrada": "12:00", "hora_almoco_saida": "12:00", "hora_saida": "23:59", "ativo": "1" } ] } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Usuários da empresa, com indicação de acesso master ao módulo de Assinatura Digital.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/lojas": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar lojas", "operationId": "core_lojas_listar", "x-modulo": "core", "x-recurso": "lojas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome da loja (busca parcial)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "1", "nome": "Matriz" }, { "id": "2", "nome": "Filial" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Lojas/index", "x-ia": "Consulte antes de dar um número que dependa de loja: o loja_id dos outros recursos sai daqui. Entram só as lojas que o usuário da chave acessa — não é, necessariamente, a empresa inteira. Busca por nome sem resultado devolve data com um item vazio ([[]]): trate como nenhuma loja.", "description": "Lista as lojas que o usuário da chave acessa, só com id e nome, sem paginação. Os dados da loja (CNPJ, endereço, regime tributário) estão no detalhe, GET /lojas/{id}.\n\n**Permissão exigida:** `Lojas/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/lojas/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar lojas", "operationId": "core_lojas_visualizar", "x-modulo": "core", "x-recurso": "lojas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Lojas/visualizar", "x-ia": "Os dados ficam em data.Loja (não direto em data). matriz 1 = matriz; ativo 1 = ativa.", "description": "Detalhe de uma loja que o usuário da chave acessa, dentro de data.Loja: razão social, nome fantasia, CNPJ/CPF, inscrições, regime tributário, contatos, endereço e fuso. Loja inexistente ou que a chave não acessa é 404.\n\n**Permissão exigida:** `Lojas/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/cep": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar consulta de CEP", "operationId": "core_cep_listar", "x-modulo": "core", "x-recurso": "cep", "x-operacao": "listar", "parameters": [ { "name": "cep", "in": "query", "required": false, "description": "string — obrigatório, 8 dígitos (pontuação é ignorada)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "cep": { "type": "string" }, "logradouro": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cidade_id": { "type": "string" }, "nome_cidade": { "type": "string" }, "codigo_cidade": { "type": "string" }, "estado": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "cep": "30110-001", "logradouro": "Avenida do Contorno", "complemento": "até 1191 - lado ímpar", "bairro": "Centro", "cidade_id": "1411", "nome_cidade": "Belo Horizonte", "codigo_cidade": "3106200", "estado": "MG" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Sem cep é 400; CEP com menos de 8 dígitos é 400 (\"Insira um CEP válido!\"); inexistente é 400 (\"CEP não encontrado!\"). A resposta é um objeto só, com cidade_id e codigo_cidade (IBGE); o número do imóvel não vem.", "description": "Devolve o endereço do CEP e o `cidade_id` do cadastro de cidades, pronto para o cadastro de cliente ou fornecedor. A consulta vai a um serviço público de CEP (ViaCEP, com OpenCEP de reserva); CEP inexistente ou serviço fora do ar é 400.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/aplicativos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar aplicativos do plano", "operationId": "core_conta_aplicativos_listar", "x-modulo": "core", "x-recurso": "conta_aplicativos", "x-operacao": "listar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "empresa": { "type": "object", "properties": { "nome": { "type": "string" } } }, "plano": { "type": "object", "properties": { "nome": { "type": "string" }, "periodo": { "type": "string" }, "vencimento": { "type": "string" }, "situacao": { "type": "string" }, "forma_pagamento": { "type": "string" } } }, "contratados": { "type": "array", "items": { "type": "object", "properties": { "referencia": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "quantidade": { "type": "integer" } } } }, "em_teste": { "type": "object", "properties": [] }, "teste_encerrado": { "type": "object", "properties": [] }, "contratar": { "type": "string" }, "indisponivel": { "type": [ "string", "null" ] } } } } }, "example": { "code": 200, "status": "success", "meta": { "cache": false }, "data": { "empresa": { "nome": "MENU TECNOLOGIA - Fantasia" }, "plano": { "nome": "Prata", "periodo": "mensal", "vencimento": "2026-11-09", "situacao": "em_dia", "forma_pagamento": "não definida" }, "contratados": [ { "referencia": "webdesk", "nome": "Área do Cliente", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "gerencia_net", "nome": "GerenciaNet", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "pag_seguro", "nome": "Pag Seguro", "tipo": "aplicativo", "quantidade": 2 }, { "referencia": "mercado_pago", "nome": "Mercado Pago", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "pag_hiper", "nome": "PagHiper", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "pipedrive", "nome": "Pipedrive", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "send_grid", "nome": "SendGrid", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "nuvem_shop", "nome": "NuvemShop", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "mercado_livre", "nome": "Mercado Livre", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "loja_integrada", "nome": "Loja Integrada", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "cobrancas", "nome": "Cobranças", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "integracao_api", "nome": "API", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "banco_inter", "nome": "Banco Inter", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "ecommerce", "nome": "Loja Virtual", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "assinatura_digital", "nome": "Assinatura Digital", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "cora", "nome": "Cora", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "iugu", "nome": "Iugu", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "expedicao", "nome": "Expedição", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "tray", "nome": "Tray", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "cte", "nome": "Ct-e", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "mdfe", "nome": "MDF-e", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "controle_producao", "nome": "Controle de Produção", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "crm", "nome": "CRM", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "controle_bens", "nome": "Controle de Benas", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "shopee", "nome": "Shopee", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "recursos_humanos", "nome": "RH", "tipo": "aplicativo", "quantidade": 1 } ], "em_teste": [], "teste_encerrado": [], "contratar": "Configurações › Meu plano › Contratar recurso", "indisponivel": null } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "data.contratados: aplicativos pagos no plano atual. data.em_teste e data.teste_encerrado: testes grátis (vence_em em AAAA-MM-DD; loja quando o teste é por loja); um aplicativo contratado não aparece nas listas de teste. data.contratar é o caminho de tela para contratar. Recursos que não são aplicativo (usuários, lojas, notas) ficam em /conta/renovacao. data.plano.situacao: em_dia, atrasado (venceu e a prorrogação ainda segura o acesso), bloqueado (passou a prorrogação), teste ou teste_expirado (plano de valor zero). Regra de negócio volta como DADO, nunca como erro: quando algo não está disponível o bloco vem com disponivel: false, motivo (identificador estável) e orientacao (o que dizer ao cliente) — repasse a orientacao em vez de inventar. data.indisponivel só vem preenchido quando a empresa não tem plano vigente (motivo sem_plano). É a assinatura da PRÓPRIA empresa neste sistema, não os contratos que ela vende aos clientes dela.", "description": "Aplicativos (integrações) da assinatura deste sistema: os contratados no plano vigente, os que estão em teste grátis e os com teste encerrado sem contratação.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/boleto": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar boleto da renovação", "operationId": "core_conta_boleto_listar", "x-modulo": "core", "x-recurso": "conta_boleto", "x-operacao": "listar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "empresa": { "type": "object", "properties": { "nome": { "type": "string" }, "dominio": { "type": "string" } } }, "plano": { "type": "object", "properties": { "nome": { "type": "string" }, "periodo": { "type": "string" }, "vencimento": { "type": "string" }, "situacao": { "type": "string" }, "forma_pagamento": { "type": "string" } } }, "boleto": { "type": "object", "properties": { "disponivel": { "type": "boolean" }, "motivo": { "type": "string" }, "orientacao": { "type": "string" } } }, "indisponivel": { "type": [ "string", "null" ] } } } } }, "example": { "code": 200, "status": "success", "meta": { "cache": false }, "data": { "empresa": { "nome": "MENU TECNOLOGIA - Fantasia", "dominio": "http://localhost:8080" }, "plano": { "nome": "Prata", "periodo": "mensal", "vencimento": "2026-11-09", "situacao": "em_dia", "forma_pagamento": "não definida" }, "boleto": { "disponivel": false, "motivo": "plano_em_dia", "orientacao": "O plano está em dia e não há boleto em aberto. Quem quiser antecipar a renovação faz isso em Configurações › Meu plano, no botão Renovar assinatura." }, "indisponivel": null } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "data.boleto.disponivel true traz url (link da página do boleto: entregue inteiro, com o ?b=, sem encurtar; o valor não vem neste bloco — está no boleto, não calcule) e origem: existente = cobrança pendente recente já registrada; gerado = cobrança da renovação registrada nesta consulta. Com o plano vencido e sem cobrança pendente recente, a consulta REGISTRA a cobrança da renovação (idempotente: a próxima consulta devolve a mesma, nunca duplica; a fatura no meio de pagamento só nasce quando o link é aberto). disponivel false traz motivo e orientacao: plano_em_dia (não há o que pagar; antecipar é pela tela), cobranca_por_parceiro, plano_teste e plano_teste_expirado (no teste não há o que renovar: a orientação é contratar um plano), atraso_prolongado (mensal vencido há mais de 25 dias), dados_cobranca_incompletos, falha_geracao, sem_plano. data.plano.situacao: em_dia, atrasado (venceu e a prorrogação ainda segura o acesso), bloqueado (passou a prorrogação), teste ou teste_expirado (plano de valor zero). Regra de negócio volta como DADO, nunca como erro: quando algo não está disponível o bloco vem com disponivel: false, motivo (identificador estável) e orientacao (o que dizer ao cliente) — repasse a orientacao em vez de inventar. data.indisponivel só vem preenchido quando a empresa não tem plano vigente (motivo sem_plano). É a assinatura da PRÓPRIA empresa neste sistema, não os contratos que ela vende aos clientes dela.", "description": "O link do boleto para pagar a renovação da assinatura deste sistema agora — o mesmo que a tela Meu plano entrega — ou o motivo de não haver boleto.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/certificado_digital": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar certificado digital", "operationId": "core_conta_certificado_digital_listar", "x-modulo": "core", "x-recurso": "conta_certificado_digital", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele vem uma entrada por loja que o usuário da chave acessa (o certificado é por loja)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "lojas": { "type": "array", "items": { "type": "object", "properties": { "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "modelo_em_uso": { "type": "string" }, "situacao": { "type": "string" }, "a1": { "type": "object", "properties": { "validade": { "type": "string" }, "dias_para_vencer": { "type": "integer" }, "situacao": { "type": "string" }, "mensagem": { "type": "string" }, "titular": { "type": [ "string", "null" ] }, "documento_titular": { "type": [ "string", "null" ] }, "emissor": { "type": [ "string", "null" ] } } }, "a3": { "type": "object", "properties": { "validade": { "type": "string" }, "dias_para_vencer": { "type": "integer" }, "situacao": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 65 ], "cache": false }, "data": { "lojas": [ { "loja_id": "65", "nome_loja": "Master", "modelo_em_uso": "A1", "situacao": "senha_incorreta", "a1": { "validade": "2026-10-17", "dias_para_vencer": -10, "situacao": "senha_incorreta", "mensagem": "Senha incorreta. Por favor, remova e reenvie o certificado novamente.", "titular": null, "documento_titular": null, "emissor": null }, "a3": { "validade": "2026-12-11", "dias_para_vencer": 45, "situacao": "valido" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Configuracoes/certificado_digital", "x-ia": "O certificado é da LOJA, não da empresa: cada item de data.lojas é uma loja. `situacao` é a do modelo em uso (`modelo_em_uso`: A1 = arquivo enviado ao sistema, A3 = cartão/token no computador) — é ela que vale para emitir NF-e/NFC-e: valido, vencido, senha_incorreta (o arquivo não abre com a senha gravada: a orientação da tela é remover e reenviar o certificado com a senha certa) ou ausente (nenhum certificado desse modelo na loja). dias_para_vencer negativo = já venceu há tantos dias. titular/documento_titular/emissor só existem no A1 que abre com a senha; o A3 só tem a validade digitada pelo usuário, e o sistema não confere o cartão. a1/a3 null = não cadastrado. Para trocar, enviar ou remover o certificado, oriente a tela Configurações › Certificado digital — a API não altera. Resposta em cache de até 5 minutos.", "description": "Situação do certificado digital (A1 e A3) de cada loja, como a tela Configurações › Certificado digital mostra: validade, dias para vencer, titular e CNPJ/CPF do A1 e qual modelo a loja usa para emitir. O arquivo, a senha e o caminho do certificado nunca saem.\n\n**Permissão exigida:** `Configuracoes/certificado_digital` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/configuracoes": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar configurações gerais", "operationId": "core_conta_configuracoes_listar", "x-modulo": "core", "x-recurso": "conta_configuracoes", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja em data.lojas; sem ele vem uma entrada por loja que o usuário da chave acessa (data.empresa é sempre o mesmo)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "empresa": { "type": "object", "properties": { "metodo_numeracao": { "type": "integer" }, "casas_decimais_quantidade": { "type": "integer" }, "casas_decimais_valor": { "type": "integer" }, "limite_registros_paginas": { "type": "integer" }, "limite_anexos": { "type": "integer" }, "permitir_duplicar_codigo": { "type": [ "string", "null" ] }, "bloquear_entidade_cpf_cnpj_duplicado": { "type": "integer" }, "controlar_estoque_produto": { "type": "integer" }, "utiliza_controle_lote": { "type": "integer" }, "numeracao_cliente": { "type": "integer" }, "numeracao_fornecedor": { "type": "integer" }, "numeracao_transportadora": { "type": "integer" }, "financeiro_bloquear_credito_alcancado": { "type": "integer" }, "financeiro_buscar_pendencias": { "type": "integer" }, "financeiro_possui_controle_cheque": { "type": "integer" }, "financeiro_formulario_exibir_lojas": { "type": "integer" }, "financeiro_formulario_exibir_data_boleto": { "type": "integer" }, "financeiro_lista_exibir_centro_custo": { "type": "integer" }, "financeiro_lista_exibir_conta_bancaria": { "type": "integer" }, "boleto_calcular_tarifa": { "type": "integer" }, "boleto_calcular_multa": { "type": "integer" }, "boleto_calcular_desconto": { "type": "integer" }, "pdv_habilitar_nfc_e": { "type": "integer" }, "pdv_lancar_estoque": { "type": "integer" }, "pdv_lancar_financeiro": { "type": "integer" }, "pdv_situacao_padrao": { "type": "integer" }, "pdv_sempre_indicar_vendedor": { "type": "integer" }, "pdv_sempre_indicar_cliente": { "type": "integer" }, "pdv_habilitar_canal_venda": { "type": "integer" }, "pdv_adicionar_produto_automaticamente": { "type": "integer" }, "pedidos_formulario_exibir_valor_custo": { "type": "integer" }, "pedidos_exibir_campo_aux_texto_1": { "type": "string" }, "pedidos_exibir_campo_aux_texto_2": { "type": "string" }, "compras_formulario_exibir_centro_custo": { "type": "integer" }, "compras_xml_filtro_produto": { "type": "integer" }, "atendimentos_formulario_atendente_obrigatorio": { "type": "integer" }, "enviar_email_cliente_novo_atendimento": { "type": "integer" }, "enviar_email_cliente_responder_atendimento": { "type": "integer" }, "os_lista_exibir_opcoes_impressao": { "type": "integer" }, "impressao_multiplicar_valor_metro_quadrado": { "type": "integer" }, "nfse_alterar_manualmente": { "type": "integer" }, "baixar_pdf_automaticamente": { "type": "integer" }, "permitir_acesso_suporte": { "type": "integer" }, "permitir_acesso_certificado": { "type": "integer" }, "notificacao_novo_atendimento": { "type": "string" }, "notificacao_interacao_atendimento": { "type": "string" }, "notificacao_indicar_atendente": { "type": "string" }, "notificacao_pagamento_dia": { "type": "string" }, "notificacao_recebimento_dia": { "type": "string" }, "notificacao_pagamento_atrasado": { "type": "string" }, "notificacao_recebimento_atrasado": { "type": "string" }, "notificacao_agendamento_dia": { "type": "string" }, "notificacao_cotacao_respondida": { "type": "string" }, "notificacao_mensagem_recebida": { "type": "string" }, "smtp_proprio": { "type": "boolean" }, "autorizacoes_xml": { "type": "object", "properties": [] } } }, "lojas": { "type": "array", "items": { "type": "object", "properties": { "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "nota_fiscal_ambiente": { "type": "integer" }, "nota_fiscal_consumidor_ambiente": { "type": "integer" }, "nota_fiscal_servico_ambiente": { "type": "integer" }, "modelo_certificado_digital": { "type": "integer" }, "versao_nf": { "type": "string" }, "versao_nfse": { "type": "integer" }, "regime_especial_tributacao_nacional": { "type": "string" }, "situacao_simples_nacional": { "type": "integer" }, "simples_apuracao_sn": { "type": "integer" }, "numeracao_orcamento": { "type": "integer" }, "numeracao_pedido": { "type": "integer" }, "numeracao_pedido_pdv": { "type": "integer" }, "numeracao_pedido_os": { "type": "integer" }, "numeracao_contrato": { "type": "integer" }, "numeracao_locacao": { "type": "integer" }, "numeracao_financeiro": { "type": "integer" }, "numeracao_financeiro_fixo": { "type": "integer" }, "numeracao_cotacao": { "type": "integer" }, "numeracao_compra": { "type": "integer" }, "numeracao_ordem_servico": { "type": "integer" }, "numeracao_ajuste_estoque": { "type": "integer" }, "numeracao_transferencia_estoque": { "type": "integer" }, "numeracao_atendimento": { "type": "integer" }, "numeracao_devolucao": { "type": "integer" }, "numeracao_nf": { "type": "integer" }, "numeracao_nfc": { "type": "integer" }, "numeracao_nfs": { "type": "integer" }, "natureza_operacao_nfs": { "type": "string" }, "pedido_tamanho_fonte_pdf": { "type": "integer" }, "pedido_formato": { "type": "string" }, "compra_exibir_item_produto": { "type": "integer" }, "compra_exibir_codigo_produto": { "type": "integer" }, "compra_exibir_unidade_produto": { "type": "integer" }, "compra_exibir_ncm": { "type": "integer" }, "compra_exibir_imagem_produto": { "type": "integer" }, "compra_exibir_descricao_produto": { "type": "integer" }, "compra_exibir_valor_unitario": { "type": "integer" }, "compra_exibir_valor_total": { "type": "integer" }, "compra_xml_considerar_frete_produto": { "type": "integer" }, "compra_xml_considerar_desconto_produto": { "type": "integer" }, "compra_xml_considerar_despesa_produto": { "type": "integer" }, "compra_xml_considerar_impostos_produto": { "type": "integer" }, "pedido_exibir_item_produto": { "type": "integer" }, "pedido_exibir_codigo_produto": { "type": "integer" }, "pedido_exibir_unidade_produto": { "type": "integer" }, "pedido_exibir_ncm": { "type": "integer" }, "pedido_exibir_imagem_produto": { "type": "integer" }, "pedido_exibir_imagem_servico": { "type": "integer" }, "pedido_exibir_descricao_produto": { "type": "integer" }, "pedido_exibir_descricao_servico": { "type": "integer" }, "pedido_nomenclatura_vendedor": { "type": "string" }, "pedido_exibir_valor_unitario": { "type": "integer" }, "pedido_exibir_cupom_presente": { "type": "integer" }, "pedido_exibir_valor_total": { "type": "integer" }, "orcamento_exibir_item_produto": { "type": "integer" }, "orcamento_exibir_codigo_produto": { "type": "integer" }, "orcamento_exibir_unidade_produto": { "type": "integer" }, "orcamento_exibir_ncm": { "type": "integer" }, "orcamento_exibir_valor_unitario": { "type": "integer" }, "orcamento_exibir_valor_total": { "type": "integer" }, "orcamento_exibir_imagem_produto": { "type": "integer" }, "orcamento_exibir_imagem_servico": { "type": "integer" }, "orcamento_exibir_descricao_produto": { "type": "integer" }, "orcamento_exibir_descricao_servico": { "type": "integer" }, "orcamento_nomenclatura_vendedor": { "type": "string" }, "os_exibir_item_produto": { "type": "integer" }, "os_exibir_codigo_produto": { "type": "integer" }, "os_exibir_unidade_produto": { "type": "integer" }, "os_exibir_ncm": { "type": "integer" }, "os_exibir_valor_unitario": { "type": "integer" }, "os_exibir_valor_total": { "type": "integer" }, "os_exibir_imagem_produto": { "type": "integer" }, "os_exibir_imagem_servico": { "type": "integer" }, "os_exibir_descricao_produto": { "type": "integer" }, "os_exibir_descricao_servico": { "type": "integer" }, "os_exibir_atividades": { "type": "integer" }, "nfe_exibir_danfe_simplificado": { "type": "integer" }, "nfe_subtrair_icms_pis_cofins": { "type": "integer" }, "nfc_tamanho_fonte": { "type": "integer" }, "nfc_largura_papel": { "type": "integer" }, "tamanho_fonte_cupom": { "type": "integer" }, "tamanho_largura_cupom": { "type": "integer" }, "numeracao_rps": { "type": "integer" }, "numeracao_serie_nfe": { "type": "string" }, "numeracao_serie_nfc": { "type": "string" }, "numeracao_serie_nfs": { "type": "string" }, "nfs_exibir_iss": { "type": "integer" }, "observacoes_compras": { "type": "string" }, "observacoes_cotacoes": { "type": "string" }, "introducao_orcamentos": { "type": "string" }, "observacoes_orcamentos": { "type": "string" }, "observacoes_vendas": { "type": "string" }, "observacoes_os": { "type": "string" }, "observacoes_contratos": { "type": "string" }, "observacoes_servicos_recorrentes": { "type": "string" }, "observacoes_locacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "texto_final_cupom": { "type": "string" }, "condicoes_os": { "type": "string" }, "termos_os": { "type": "string" }, "observacoes_nfe": { "type": "string" }, "observacoes_nfce": { "type": "string" }, "observacoes_nfse": { "type": "string" }, "lancar_caixa_financeiro": { "type": "integer" }, "contabilidade_sistema_contabil": { "type": "string" }, "controlar_estoque_produto_composicao": { "type": "integer" }, "permitir_venda_estoque_insuficiente": { "type": "integer" }, "permitir_venda_sem_pagamento": { "type": "integer" }, "atualizar_valor_custo": { "type": "integer" }, "cobrancas_gerar_reguas": { "type": "integer" }, "cobrancas_gerar_planos": { "type": "integer" }, "exibir_miniatura_pdv": { "type": "integer" }, "habilitar_pix_pdv": { "type": "integer" }, "pdv_offline_modo": { "type": "integer" }, "lote_saida_automatica": { "type": "string" }, "lote_selecao_padrao": { "type": "string" }, "descricao_nota_fiscal_ambiente": { "type": "string" }, "descricao_nota_fiscal_consumidor_ambiente": { "type": "string" }, "descricao_nota_fiscal_servico_ambiente": { "type": "string" }, "nfc_csc_configurado": { "type": "boolean" }, "nfse_acesso_configurado": { "type": "boolean" }, "pdv_balanca": { "type": [ "string", "null" ] }, "inscricao_municipal": { "type": "string" }, "regime_tributario": { "type": "string" }, "regime_especial_tributacao": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 65 ], "cache": false }, "data": { "empresa": { "metodo_numeracao": 1, "casas_decimais_quantidade": 2, "casas_decimais_valor": 2, "limite_registros_paginas": 20, "limite_anexos": 10, "permitir_duplicar_codigo": null, "bloquear_entidade_cpf_cnpj_duplicado": 0, "controlar_estoque_produto": 1, "utiliza_controle_lote": 0, "numeracao_cliente": 67, "numeracao_fornecedor": 25, "numeracao_transportadora": 20, "financeiro_bloquear_credito_alcancado": 1, "financeiro_buscar_pendencias": 0, "financeiro_possui_controle_cheque": 0, "financeiro_formulario_exibir_lojas": 0, "financeiro_formulario_exibir_data_boleto": 0, "financeiro_lista_exibir_centro_custo": 0, "financeiro_lista_exibir_conta_bancaria": 0, "boleto_calcular_tarifa": 1, "boleto_calcular_multa": 1, "boleto_calcular_desconto": 1, "pdv_habilitar_nfc_e": 1, "pdv_lancar_estoque": 1, "pdv_lancar_financeiro": 1, "pdv_situacao_padrao": 2, "pdv_sempre_indicar_vendedor": 0, "pdv_sempre_indicar_cliente": 0, "pdv_habilitar_canal_venda": 0, "pdv_adicionar_produto_automaticamente": 0, "pedidos_formulario_exibir_valor_custo": 0, "pedidos_exibir_campo_aux_texto_1": "", "pedidos_exibir_campo_aux_texto_2": "", "compras_formulario_exibir_centro_custo": 0, "compras_xml_filtro_produto": 1, "atendimentos_formulario_atendente_obrigatorio": 1, "enviar_email_cliente_novo_atendimento": 0, "enviar_email_cliente_responder_atendimento": 0, "os_lista_exibir_opcoes_impressao": 0, "impressao_multiplicar_valor_metro_quadrado": 1, "nfse_alterar_manualmente": 0, "baixar_pdf_automaticamente": 0, "permitir_acesso_suporte": 1, "permitir_acesso_certificado": 0, "notificacao_novo_atendimento": "S", "notificacao_interacao_atendimento": "S", "notificacao_indicar_atendente": "S", "notificacao_pagamento_dia": "S", "notificacao_recebimento_dia": "S", "notificacao_pagamento_atrasado": "S", "notificacao_recebimento_atrasado": "S", "notificacao_agendamento_dia": "S", "notificacao_cotacao_respondida": "SE", "notificacao_mensagem_recebida": "S", "smtp_proprio": false, "autorizacoes_xml": [] }, "lojas": [ { "loja_id": "65", "nome_loja": "Master", "nota_fiscal_ambiente": 2, "nota_fiscal_consumidor_ambiente": 2, "nota_fiscal_servico_ambiente": 2, "modelo_certificado_digital": 1, "versao_nf": "4.00", "versao_nfse": 0, "regime_especial_tributacao_nacional": "0", "situacao_simples_nacional": 0, "simples_apuracao_sn": 0, "numeracao_orcamento": 3529, "numeracao_pedido": 28978004, "numeracao_pedido_pdv": 0, "numeracao_pedido_os": 173, "numeracao_contrato": 10019, "numeracao_locacao": 109, "numeracao_financeiro": 3283, "numeracao_financeiro_fixo": 39, "numeracao_cotacao": 120, "numeracao_compra": 594534423, "numeracao_ordem_servico": 0, "numeracao_ajuste_estoque": 36, "numeracao_transferencia_estoque": 73, "numeracao_atendimento": 543534565, "numeracao_devolucao": 78, "numeracao_nf": 6050, "numeracao_nfc": 6021, "numeracao_nfs": 0, "natureza_operacao_nfs": "1", "pedido_tamanho_fonte_pdf": 12, "pedido_formato": "pdf", "compra_exibir_item_produto": 1, "compra_exibir_codigo_produto": 1, "compra_exibir_unidade_produto": 1, "compra_exibir_ncm": 1, "compra_exibir_imagem_produto": 1, "compra_exibir_descricao_produto": 1, "compra_exibir_valor_unitario": 1, "compra_exibir_valor_total": 1, "compra_xml_considerar_frete_produto": 1, "compra_xml_considerar_desconto_produto": 1, "compra_xml_considerar_despesa_produto": 1, "compra_xml_considerar_impostos_produto": 1, "pedido_exibir_item_produto": 1, "pedido_exibir_codigo_produto": 0, "pedido_exibir_unidade_produto": 1, "pedido_exibir_ncm": 1, "pedido_exibir_imagem_produto": 1, "pedido_exibir_imagem_servico": 0, "pedido_exibir_descricao_produto": 1, "pedido_exibir_descricao_servico": 0, "pedido_nomenclatura_vendedor": "Vendedor", "pedido_exibir_valor_unitario": 1, "pedido_exibir_cupom_presente": 1, "pedido_exibir_valor_total": 1, "orcamento_exibir_item_produto": 1, "orcamento_exibir_codigo_produto": 1, "orcamento_exibir_unidade_produto": 1, "orcamento_exibir_ncm": 1, "orcamento_exibir_valor_unitario": 1, "orcamento_exibir_valor_total": 1, "orcamento_exibir_imagem_produto": 0, "orcamento_exibir_imagem_servico": 0, "orcamento_exibir_descricao_produto": 1, "orcamento_exibir_descricao_servico": 1, "orcamento_nomenclatura_vendedor": "Vendedor", "os_exibir_item_produto": 1, "os_exibir_codigo_produto": 0, "os_exibir_unidade_produto": 1, "os_exibir_ncm": 1, "os_exibir_valor_unitario": 1, "os_exibir_valor_total": 1, "os_exibir_imagem_produto": 0, "os_exibir_imagem_servico": 0, "os_exibir_descricao_produto": 0, "os_exibir_descricao_servico": 0, "os_exibir_atividades": 0, "nfe_exibir_danfe_simplificado": 0, "nfe_subtrair_icms_pis_cofins": 0, "nfc_tamanho_fonte": 8, "nfc_largura_papel": 80, "tamanho_fonte_cupom": 9, "tamanho_largura_cupom": 400, "numeracao_rps": 181534553, "numeracao_serie_nfe": "2", "numeracao_serie_nfc": "1", "numeracao_serie_nfs": "99", "nfs_exibir_iss": 1, "observacoes_compras": "aaa xxx\r\nTeste:\r\nTeste", "observacoes_cotacoes": "", "introducao_orcamentos": "introdução de orçamento", "observacoes_orcamentos": "observação de orçamentoxxx", "observacoes_vendas": "observação de venda", "observacoes_os": "texto1\r\ntexto 2", "observacoes_contratos": "Serviços", "observacoes_servicos_recorrentes": "Assinaturas", "observacoes_locacoes": "Locações", "observacoes_fatura": "Nos termos da Lei Complementar no 116/2003, a atividade de locação de bens não se", "texto_final_cupom": "NÃO FAZEMOS DEVOLUÇÃO DE DINHEIROPRAZO MAXIMO DE TROCA 24 HORAS COM EMBALAGEM EM PERFEITO ESTADO E COM NOTA!--------------------------------------------------Assinatura do clienteOBRIGADO E VOLTE SEMPRE!", "condicoes_os": "", "termos_os": "Validade do orçamento: 10 dias a contar da emissão.", "observacoes_nfe": "I - DOCUMENTO EMITIDO POR ME OU EPP OPTANTE PELO SIMPLES NACIONAL; II - NÃO GERA DIREITO A CRÉDITO FISCAL DE ICMS, DE ISS E DE IPI.", "observacoes_nfce": "Obrigado pela preferência!", "observacoes_nfse": "teste", "lancar_caixa_financeiro": 0, "contabilidade_sistema_contabil": "Dominio", "controlar_estoque_produto_composicao": 1, "permitir_venda_estoque_insuficiente": 1, "permitir_venda_sem_pagamento": 1, "atualizar_valor_custo": 2, "cobrancas_gerar_reguas": 1, "cobrancas_gerar_planos": 1, "exibir_miniatura_pdv": 0, "habilitar_pix_pdv": 1, "pdv_offline_modo": 0, "lote_saida_automatica": "validade", "lote_selecao_padrao": "validade", "descricao_nota_fiscal_ambiente": "Homologação", "descricao_nota_fiscal_consumidor_ambiente": "Homologação", "descricao_nota_fiscal_servico_ambiente": "Homologação", "nfc_csc_configurado": true, "nfse_acesso_configurado": true, "pdv_balanca": null, "inscricao_municipal": "0000000000000", "regime_tributario": "3", "regime_especial_tributacao": "0" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Configuracoes/gerais", "x-ia": "Flags são 1 = ligado, 0 = desligado; null = sem valor gravado (a tela mostra como desligado). Venda sem estoque, venda sem pagamento, atualizar custo e composição valem POR LOJA (data.lojas: permitir_venda_estoque_insuficiente etc.), não pela empresa. Ambiente das notas por loja: nota_fiscal_ambiente (NF-e), nota_fiscal_consumidor_ambiente (NFC-e), nota_fiscal_servico_ambiente (NFS-e) — 1 Produção, 2 Homologação (teste, sem valor fiscal), texto em descricao_*. numeracao_* é o ÚLTIMO número usado: o próximo documento sai com +1 (numeracao_serie_* é a própria série). metodo_numeracao: 0 = numeração compartilhada pelas lojas do usuário, 1 = cada loja tem a sua, 2 = compartilhada entre lojas do mesmo CNPJ. versao_nfse 1 = NFS-e Nacional, 0 = prefeitura/integradora. nfc_csc_configurado / nfse_acesso_configurado / smtp_proprio só dizem SE o dado está preenchido — o valor nunca sai: se a NFC-e reclama do CSC, oriente conferir o CSC e o ID do token na tela. modelo_certificado_digital 1 = A1, 3 = A3 (detalhes em /conta/certificado_digital). Observações padrão (observacoes_*) saem sem HTML. Para alterar, oriente a tela Configurações › Configurações gerais (a API não altera). Resposta em cache de até 5 minutos.", "description": "As configurações gerais do sistema como a tela Configurações › Configurações gerais mostra: em data.empresa as que valem para a empresa toda (casas decimais, numeração de cadastros, estoque, lote, PDV, financeiro, boleto, notificações) e em data.lojas as de cada loja (ambiente das notas, numerações e séries, impressão de vendas/orçamentos/OS/compras, NFC-e, observações padrão, venda sem estoque). Senhas, SMTP, CSC da NFC-e, acesso à prefeitura e IP do app local nunca saem.\n\n**Permissão exigida:** `Configuracoes/gerais` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/dados_cobranca": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar dados de cobrança do plano", "operationId": "core_conta_dados_cobranca_listar", "x-modulo": "core", "x-recurso": "conta_dados_cobranca", "x-operacao": "listar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "dados_cobranca": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "cpf_cnpj": { "type": "string" }, "nome_fantasia": { "type": "string" }, "razao_social": { "type": "string" }, "telefone": { "type": "string" }, "email": { "type": "string" }, "forma_pagamento": { "type": "string" }, "pagamento_recorrente": { "type": "string" }, "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "nome_cidade": { "type": "string" }, "estado": { "type": "string" }, "descricao_forma_pagamento": { "type": "string" } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "cache": false }, "data": { "dados_cobranca": { "tipo_pessoa": "PJ", "cpf_cnpj": "00.000.000/0001-91", "nome_fantasia": "", "razao_social": "Empresa Teste GCK-22518", "telefone": "(31)0000-0000", "email": "teste@exemplo.com", "forma_pagamento": "BB", "pagamento_recorrente": "0", "cep": "30000-000", "logradouro": "Rua de Teste", "numero": "100", "complemento": "", "bairro": "Centro", "nome_cidade": "Belo Horizonte", "estado": "MG", "descricao_forma_pagamento": "Boleto" } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "É o pagador da assinatura do PRÓPRIO ERP (quem recebe a cobrança e a NFS-e do sistema), não o cadastro da empresa nem de clientes. dados_cobranca null = ainda não há dados de cobrança cadastrados. forma_pagamento: código (BB = boleto, CV/CM/ELO… = cartão) com o nome em descricao_forma_pagamento; pagamento_recorrente 1 = cobrança automática no cartão. Número, validade e token do cartão nunca saem por aqui: a alteração é feita pelo usuário na tela Meu plano.", "description": "Os dados de cobrança da assinatura deste sistema: pagador (razão social, CPF/CNPJ, contato), endereço de faturamento, forma de pagamento e se o pagamento é recorrente. Dados de cartão não saem.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/dados_empresa": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar dados da empresa", "operationId": "core_conta_dados_empresa_listar", "x-modulo": "core", "x-recurso": "conta_dados_empresa", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele vem uma entrada por loja que o usuário da chave acessa", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "lojas": { "type": "array", "items": { "type": "object", "properties": { "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "nome": { "type": "string" }, "matriz": { "type": "integer" }, "ativo": { "type": "integer" }, "tipo_pessoa": { "type": "string" }, "razao_social": { "type": "string" }, "nome_fantasia": { "type": "string" }, "cnpj": { "type": "string" }, "cpf": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "isenta_ins_est": { "type": "integer" }, "inscricao_municipal": { "type": "string" }, "codigo_cnae": { "type": "string" }, "descricao_cnae": { "type": "string" }, "regime_tributario": { "type": "integer" }, "regime_especial_tributacao": { "type": "integer" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "site": { "type": "string" }, "cep": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "nome_cidade": { "type": "string" }, "codigo_cidade": { "type": "string" }, "estado": { "type": "string" }, "timezone": { "type": "string" }, "descricao_regime_tributario": { "type": "string" }, "descricao_regime_especial_tributacao": { "type": "string" }, "sistema_contabil": { "type": "string" }, "inscricoes_estaduais_st": { "type": "object", "properties": [] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 65 ], "cache": false }, "data": { "lojas": [ { "loja_id": "65", "nome_loja": "Master", "nome": "Master", "matriz": 1, "ativo": 1, "tipo_pessoa": "PJ", "razao_social": "Empresa Teste GCK-22578 Ltda", "nome_fantasia": "Empresa Teste", "cnpj": "00.000.000/0001-91", "cpf": "", "inscricao_estadual": "0000000000000", "isenta_ins_est": 0, "inscricao_municipal": "0000000000000", "codigo_cnae": "6209100", "descricao_cnae": "Suporte técnico, manutenção e outros serviços em tecnologia da informação", "regime_tributario": 3, "regime_especial_tributacao": 0, "telefone": "(31) 0000-0000", "celular": "(31) 90000-0000", "email": "teste@exemplo.com", "site": "www.exemplo.com", "cep": "30000-000", "logradouro": "Rua de Teste", "numero": "100", "complemento": "", "bairro": "Centro", "nome_cidade": "Belo Horizonte", "codigo_cidade": "3106200", "estado": "MG", "timezone": "America/Sao_Paulo", "descricao_regime_tributario": "Regime Normal", "descricao_regime_especial_tributacao": "Sem regime", "sistema_contabil": "Dominio", "inscricoes_estaduais_st": [] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Configuracoes/dados_empresa", "x-ia": "São os dados do EMITENTE (a própria empresa/loja que usa o sistema), que saem nas notas fiscais e nos documentos impressos — não confundir com clientes nem com o pagador da assinatura (/conta/dados_cobranca). Cada item de data.lojas é uma loja; matriz 1 = loja matriz. regime_tributario: 1 Simples Nacional, 2 Simples com excesso de sublimite, 3 Regime Normal, 4 MEI (texto em descricao_regime_tributario); regime_especial_tributacao é o da NFS-e (texto em descricao_regime_especial_tributacao). isenta_ins_est 1 = isenta de inscrição estadual. inscricoes_estaduais_st = IE de substituto tributário em outras UFs. Para alterar, oriente a tela Configurações › Dados da empresa (a API não altera). Resposta em cache de até 5 minutos.", "description": "Os dados cadastrais de cada loja como a tela Configurações › Dados da empresa mostra: razão social, nome fantasia, CNPJ/CPF, inscrições estadual e municipal, CNAE, regime tributário, contato, endereço, fuso e as inscrições estaduais de substituto tributário.\n\n**Permissão exigida:** `Configuracoes/dados_empresa` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/integracoes": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar integrações ativas", "operationId": "core_conta_integracoes_listar", "x-modulo": "core", "x-recurso": "conta_integracoes", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa. Só faz diferença quando a empresa separa os aplicativos por loja (data.segregacao_por_loja true); sem isso o aplicativo é da empresa e cada um aparece uma vez, com loja_id null", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página, até 100 (padrão 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "assinatura": { "type": "integer" }, "teste": { "type": "integer" }, "liberado": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "loja_id": { "type": [ "string", "null" ] }, "nome_loja": { "type": [ "string", "null" ] }, "referencia": { "type": "string" }, "nome": { "type": "string" }, "situacao": { "type": "string" }, "ativo_desde": { "type": "string" }, "teste_expira_em": { "type": [ "string", "null" ] }, "teste_dias_restantes": { "type": [ "string", "null" ] }, "plano": { "type": "string" } } } }, "segregacao_por_loja": { "type": "boolean" } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 26, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": true }, "data": { "totais": { "quantidade": 26, "assinatura": 26, "teste": 0, "liberado": 0 }, "itens": [ { "loja_id": null, "nome_loja": null, "referencia": "ecommerce", "nome": "Loja Virtual", "situacao": "assinatura", "ativo_desde": "2022-02-23", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "recursos_humanos", "nome": "RH", "situacao": "assinatura", "ativo_desde": null, "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "shopee", "nome": "Shopee", "situacao": "assinatura", "ativo_desde": "2024-08-02", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "controle_bens", "nome": "Controle de Benas", "situacao": "assinatura", "ativo_desde": "2024-08-02", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "crm", "nome": "CRM", "situacao": "assinatura", "ativo_desde": "2024-03-22", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "controle_producao", "nome": "Controle de Produção", "situacao": "assinatura", "ativo_desde": "2024-07-17", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "mdfe", "nome": "MDF-e", "situacao": "assinatura", "ativo_desde": "2024-01-23", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "cte", "nome": "Ct-e", "situacao": "assinatura", "ativo_desde": "2024-01-23", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "tray", "nome": "Tray", "situacao": "assinatura", "ativo_desde": "2023-06-22", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "expedicao", "nome": "Expedição", "situacao": "assinatura", "ativo_desde": "2023-06-14", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "iugu", "nome": "Iugu", "situacao": "assinatura", "ativo_desde": "2021-04-04", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "cora", "nome": "Cora", "situacao": "assinatura", "ativo_desde": "2022-07-01", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "assinatura_digital", "nome": "Assinatura Digital", "situacao": "assinatura", "ativo_desde": "2026-09-29", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "webdesk", "nome": "Área do Cliente", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "banco_inter", "nome": "Banco Inter", "situacao": "assinatura", "ativo_desde": "2021-10-27", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "integracao_api", "nome": "API", "situacao": "assinatura", "ativo_desde": "2020-10-16", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "cobrancas", "nome": "Cobranças", "situacao": "assinatura", "ativo_desde": "2022-02-23", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "loja_integrada", "nome": "Loja Integrada", "situacao": "assinatura", "ativo_desde": "2020-10-16", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "mercado_livre", "nome": "Mercado Livre", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "nuvem_shop", "nome": "NuvemShop", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "send_grid", "nome": "SendGrid", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "pipedrive", "nome": "Pipedrive", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "pag_hiper", "nome": "PagHiper", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "mercado_pago", "nome": "Mercado Pago", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "pag_seguro", "nome": "Pag Seguro", "situacao": "assinatura", "ativo_desde": "2022-06-13", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" }, { "loja_id": null, "nome_loja": null, "referencia": "gerencia_net", "nome": "GerenciaNet", "situacao": "assinatura", "ativo_desde": "2021-07-30", "teste_expira_em": null, "teste_dias_restantes": null, "plano": "Prata" } ], "segregacao_por_loja": false } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Use para responder \"quais aplicativos/integrações a empresa usa\", \"o Mercado Livre está ativo?\", \"quando acaba o teste do X?\". data.itens = um aplicativo liberado por linha (com segregação por loja, um por loja: loja_id/nome_loja dizem qual). situacao: assinatura = contratado no plano atual (plano = nome do plano); teste = teste grátis em andamento (teste_expira_em AAAA-MM-DD e teste_dias_restantes, 0 = acaba hoje); liberado = acesso por outro motivo (ex.: bonificação), sem data de fim conhecida aqui. ativo_desde = primeira ativação registrada (pode ser null em contas antigas). Aplicativo que não está na lista NÃO está liberado — pode ter tido teste encerrado ou nunca ter sido contratado: para teste encerrado e o que dá para contratar use /conta/aplicativos; para preço use /conta/precos_recursos. Liberado não quer dizer configurado: se a integração foi conectada (conta do marketplace, banco, gateway) se vê na tela do próprio aplicativo — esta consulta não mostra credencial nem situação da conexão. data.totais conta as linhas por situação (de todas as páginas); data.itens é só uma página. Resposta em cache de até 5 minutos.", "description": "Os aplicativos (integrações) que a empresa tem liberados agora — os que aparecem com \"Acessar\" na tela Aplicativos —, com a situação (assinatura, teste grátis ou liberado) e as datas. Só o nome e a situação: credenciais, tokens, chaves, segredos e endereços de webhook das integrações nunca saem.\n\nSem permissão específica: a tela Aplicativos é aberta a todo usuário logado (não confere ACO), então qualquer chave válida consulta.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/pagamentos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar histórico de pagamentos do plano", "operationId": "core_conta_pagamentos_listar", "x-modulo": "core", "x-recurso": "conta_pagamentos", "x-operacao": "listar", "parameters": [ { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página, até 100 (padrão 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "nome_plano": { "type": "string" }, "tipo": { "type": "string" }, "valor": { "type": "number" }, "numero_parcelas": { "type": "string" }, "forma_pagamento": { "type": "string" }, "descricao_forma_pagamento": { "type": "string" }, "data_vencimento": { "type": "string" }, "atual": { "type": "string" }, "possui_nota_fiscal": { "type": "boolean" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 12, "pagina": 1, "limite": 3, "total_paginas": 4, "cache": false }, "data": { "itens": [ { "nome_plano": "Prata", "tipo": "U", "valor": 3387.73000000000001818989403545856475830078125, "numero_parcelas": "1", "forma_pagamento": "CM", "descricao_forma_pagamento": "MasterCard", "data_vencimento": "2026-11-09", "atual": "1", "possui_nota_fiscal": false }, { "nome_plano": "Platina", "tipo": "E", "valor": 2157.1999999999998181010596454143524169921875, "numero_parcelas": "1", "forma_pagamento": "CM", "descricao_forma_pagamento": "MasterCard", "data_vencimento": "2026-11-06", "atual": "0", "possui_nota_fiscal": false }, { "nome_plano": "Platina", "tipo": "E", "valor": 2541.1999999999998181010596454143524169921875, "numero_parcelas": "1", "forma_pagamento": "CM", "descricao_forma_pagamento": "MasterCard", "data_vencimento": "2026-10-06", "atual": "0", "possui_nota_fiscal": false } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "Responde \"já paguei o sistema este mês?\" sobre a assinatura do PRÓPRIO ERP — não são contas a pagar nem recebimentos da empresa. Só entram cobranças pagas e só as 12 mais recentes (não há filtro de período): uma cobrança que não aparece pode estar pendente — confira a situação em /conta/plano. valor é o total da cobrança; numero_parcelas, em quantas vezes foi paga; tipo E = contratação, U = upgrade/alteração, PE = contratação por parceiro; atual 1 = é o plano vigente. possui_nota_fiscal diz se a NFS-e da cobrança foi emitida. data.itens é só uma página.", "description": "As últimas 12 cobranças pagas da assinatura deste sistema, da mais nova para a mais antiga, com plano, valor, forma de pagamento e vencimento. É a mesma regra do histórico de pagamentos da tela Meu plano.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/plano": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar meu plano", "operationId": "core_conta_plano_listar", "x-modulo": "core", "x-recurso": "conta_plano", "x-operacao": "listar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "plano": { "type": "object", "properties": { "id": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "duracao": { "type": "string" }, "descricao_duracao": { "type": "string" }, "valor": { "type": "number" }, "acrescimo": { "type": "integer" }, "desconto": { "type": "integer" }, "valor_total": { "type": "number" }, "forma_pagamento": { "type": "string" }, "descricao_forma_pagamento": { "type": "string" }, "status_pagamento": { "type": "string" }, "situacao_descricao": { "type": "string" }, "data_vencimento": { "type": "string" }, "prorrogacao": { "type": "string" }, "pago_em": { "type": "string" }, "renovacao_automatica": { "type": "string" }, "atual": { "type": "string" }, "renovacao_automatica_aviso": { "type": "boolean" }, "data_renovacao_automatica": { "type": [ "string", "null" ] } } }, "recursos": { "type": "array", "items": { "type": "object", "properties": { "referencia": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "tipo_controle": { "type": "string" }, "quantidade": { "type": "integer" }, "data_vencimento": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "cache": false }, "data": { "plano": { "id": "117647", "plano_id": "1", "nome_plano": "Prata", "duracao": "M", "descricao_duracao": "Mensal", "valor": 3387.73000000000001818989403545856475830078125, "acrescimo": 0, "desconto": 0, "valor_total": 3387.73000000000001818989403545856475830078125, "forma_pagamento": "CM", "descricao_forma_pagamento": "MasterCard", "status_pagamento": "1", "situacao_descricao": "Ativo", "data_vencimento": "2026-11-09", "prorrogacao": "3", "pago_em": "2022-07-01", "renovacao_automatica": "0", "atual": "1", "renovacao_automatica_aviso": false, "data_renovacao_automatica": null }, "recursos": [ { "referencia": "lojas", "nome": "Lojas", "tipo": "padrao", "tipo_controle": "quantidade", "quantidade": 25, "data_vencimento": "2026-11-09" }, { "referencia": "boletos", "nome": "Emitir boletos", "tipo": "padrao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "notas_fiscais", "nome": "Emitir notas fiscais", "tipo": "padrao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "usuarios", "nome": "Usuários", "tipo": "padrao", "tipo_controle": "quantidade", "quantidade": 25, "data_vencimento": "2026-11-09" }, { "referencia": "dominio", "nome": "Layout e domínio personalizado", "tipo": "padrao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "ecommerce", "nome": "Loja Virtual", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "recursos_humanos", "nome": "RH", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "assinatura_digital", "nome": "Assinatura Digital", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "cora", "nome": "Cora", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "iugu", "nome": "Iugu", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "expedicao", "nome": "Expedição", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "tray", "nome": "Tray", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "cte", "nome": "Ct-e", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "mdfe", "nome": "MDF-e", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "controle_producao", "nome": "Controle de Produção", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "crm", "nome": "CRM", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "controle_bens", "nome": "Controle de Benas", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "shopee", "nome": "Shopee", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "banco_inter", "nome": "Banco Inter", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "integracao_api", "nome": "API", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "cobrancas", "nome": "Cobranças", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "loja_integrada", "nome": "Loja Integrada", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "mercado_livre", "nome": "Mercado Livre", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "nuvem_shop", "nome": "NuvemShop", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "send_grid", "nome": "SendGrid", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "pipedrive", "nome": "Pipedrive", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "pag_hiper", "nome": "PagHiper", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "mercado_pago", "nome": "Mercado Pago", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "pag_seguro", "nome": "Pag Seguro", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "gerencia_net", "nome": "GerenciaNet", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" }, { "referencia": "webdesk", "nome": "Área do Cliente", "tipo": "integracao", "tipo_controle": "booleano", "quantidade": 1, "data_vencimento": "2026-11-09" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "É a assinatura da PRÓPRIA empresa neste sistema (o que ela paga para usar o ERP), não os planos que a empresa vende aos clientes dela (esses são contratos). data.plano: nome_plano, valor_total da cobrança do período (descricao_duracao: Mensal, Trimestral, Semestral ou Anual), situacao_descricao (Ativo, Expirado = pago mas com vencimento passado, Pendente = cobrança não paga) e data_vencimento (a próxima cobrança/renovação). data.recursos: cada recurso contratado; com tipo_controle quantidade, quantidade é o limite (ex.: usuários 25); com booleano, 1 = contratado. tipo integracao = aplicativo adicional. Sem plano pago a resposta é 400 — diga que a empresa não tem plano pago contratado. Não expõe cartão nem dados de cobrança: para isso, /conta/dados_cobranca.", "description": "O plano que a empresa assina neste sistema — nome, valor, periodicidade, forma de pagamento, situação e vencimento — e os recursos contratados com os limites (usuários, lojas, aplicativos). É a mesma regra da tela Meu plano.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/precos_planos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar preços dos planos", "operationId": "core_conta_precos_planos_listar", "x-modulo": "core", "x-recurso": "conta_precos_planos", "x-operacao": "listar", "parameters": [ { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página, até 100 (padrão 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "valor_mensal": { "type": "integer" }, "valor_mes_no_anual": { "type": "number" }, "desconto_anual_porcentagem": { "type": "integer" }, "recursos": { "type": "object", "properties": [] } } } }, "grupo": { "type": "object", "properties": { "id": { "type": "string" }, "percentuais": { "type": "string" } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "itens": [ { "id": "79", "nome": "Plano79 local", "valor_mensal": 1, "valor_mes_no_anual": 0.65000000000000002220446049250313080847263336181640625, "desconto_anual_porcentagem": 35, "recursos": [] }, { "id": "85", "nome": "Teste GCK-22582", "valor_mensal": 131.669999999999987494447850622236728668212890625, "valor_mes_no_anual": 85.590000000000003410605131648480892181396484375, "desconto_anual_porcentagem": 35, "recursos": [ { "referencia": "usuarios", "nome": "Usuários", "quantidade": 3 } ] } ], "grupo": { "id": "21", "percentuais": "M:0.00;T:5.00;S:15.00;A:35.00" } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "Use para comparar com o plano atual (/conta/plano) quando o cliente pergunta sobre mudar de plano. valor_mensal = preço no pagamento mensal; valor_mes_no_anual = preço por mês pagando o ano, já com desconto_anual_porcentagem aplicado (o anual cobra 12 × valor_mes_no_anual). grupo.percentuais traz o desconto de cada período (M mensal, T trimestral, S semestral, A anual). recursos.quantidade é o limite do plano (usuários, lojas) ou 1/0 para incluído/não incluído. São preços de tabela: não contam cupom, reajuste do contrato nem aplicativos adicionais — o valor final sai na contratação.", "description": "A tabela de preços atual dos planos deste sistema para a marca (a mesma do site e da tela de contratação), com o preço mensal, o preço por mês no plano anual e os recursos de cada plano.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/precos_recursos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar preços dos recursos", "operationId": "core_conta_precos_recursos_listar", "x-modulo": "core", "x-recurso": "conta_precos_recursos", "x-operacao": "listar", "parameters": [ { "name": "recurso", "in": "query", "required": false, "description": "string — referência do recurso como vem em data.recursos[].referencia (ex.: usuarios, lojas, crm). Sem ele vem a tabela inteira", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "empresa": { "type": "object", "properties": { "nome": { "type": "string" } } }, "plano": { "type": "object", "properties": { "nome": { "type": "string" }, "periodo": { "type": "string" }, "vencimento": { "type": "string" }, "situacao": { "type": "string" }, "forma_pagamento": { "type": "string" } } }, "recursos": { "type": "array", "items": { "type": "object", "properties": { "referencia": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "controle": { "type": "string" }, "valor_mensal": { "type": "integer" }, "contratado": { "type": "boolean" } } } }, "observacao": { "type": "string" }, "recurso": { "type": [ "string", "null" ] }, "recurso_adicional": { "type": [ "string", "null" ] }, "preco": { "type": [ "string", "null" ] }, "indisponivel": { "type": [ "string", "null" ] } } } } }, "example": { "code": 200, "status": "success", "meta": { "cache": false }, "data": { "empresa": { "nome": "MENU TECNOLOGIA - Fantasia" }, "plano": { "nome": "Prata", "periodo": "mensal", "vencimento": "2026-11-09", "situacao": "em_dia", "forma_pagamento": "não definida" }, "recursos": [ { "referencia": "cobrancas", "nome": "Cobranças", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "recursos_humanos", "nome": "RH", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 10, "contratado": true }, { "referencia": "shopee", "nome": "Shopee", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 45, "contratado": true }, { "referencia": "controle_bens", "nome": "Controle de Benas", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "crm", "nome": "CRM", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 65, "contratado": true }, { "referencia": "controle_producao", "nome": "Controle de Produção", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 30, "contratado": true }, { "referencia": "mdfe", "nome": "MDF-e", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "cte", "nome": "Ct-e", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 25, "contratado": true }, { "referencia": "tray", "nome": "Tray", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 45, "contratado": true }, { "referencia": "expedicao", "nome": "Expedição", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 30, "contratado": true }, { "referencia": "iugu", "nome": "Iugu", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "cora", "nome": "Cora", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "assinatura_digital", "nome": "Assinatura Digital", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 40, "contratado": true }, { "referencia": "ecommerce", "nome": "Loja Virtual", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 20, "contratado": true }, { "referencia": "banco_inter", "nome": "Banco Inter", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "integracao_api", "nome": "API", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "usuarios", "nome": "Usuários", "tipo": "recurso", "controle": "quantidade", "valor_mensal": 35, "contratado": true }, { "referencia": "loja_integrada", "nome": "Loja Integrada", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 45, "contratado": true }, { "referencia": "mercado_livre", "nome": "Mercado Livre", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "nuvem_shop", "nome": "NuvemShop", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 45, "contratado": true }, { "referencia": "send_grid", "nome": "SendGrid", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "pipedrive", "nome": "Pipedrive", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "pag_hiper", "nome": "PagHiper", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "mercado_pago", "nome": "Mercado Pago", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "pag_seguro", "nome": "Pag Seguro", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "gerencia_net", "nome": "GerenciaNet", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 35, "contratado": true }, { "referencia": "dominio", "nome": "Layout e domínio personalizado", "tipo": "recurso", "controle": "booleano", "valor_mensal": 80, "contratado": true }, { "referencia": "webdesk", "nome": "Área do Cliente", "tipo": "aplicativo", "controle": "booleano", "valor_mensal": 65, "contratado": true }, { "referencia": "notas_fiscais", "nome": "Emitir notas fiscais", "tipo": "recurso", "controle": "booleano", "valor_mensal": 50, "contratado": true }, { "referencia": "boletos", "nome": "Emitir boletos", "tipo": "recurso", "controle": "booleano", "valor_mensal": 50, "contratado": true }, { "referencia": "lojas", "nome": "Lojas", "tipo": "recurso", "controle": "quantidade", "valor_mensal": 65, "contratado": true } ], "observacao": "valor_mensal é o preço cheio de tabela por mês. Para o valor exato desta empresa, consulte de novo informando o recurso.", "recurso": null, "recurso_adicional": null, "preco": null, "indisponivel": null } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "Sem recurso: data.recursos com valor_mensal = preço CHEIO de tabela por mês (sem desconto de periodicidade, reajuste nem cupom) e contratado = já está no plano. Para dizer ao cliente quanto vai pagar, consulte com recurso — não use o valor cheio da tabela. Com recurso: data.recurso (o item da tabela), data.recurso_adicional (se dá para contratar agora — trava dos 10 dias) e data.preco.acrescimo por periodicidade (mensal, trimestral, semestral, anual), com por_mes e no_periodo = o quanto a mensalidade da RENOVAÇÃO sobe; contratado no meio do período o checkout cobra o proporcional até o vencimento. data.preco.disponivel false com motivo recurso_inexistente, recurso_ja_contratado ou falha_calculo: repasse a orientacao. data.plano.situacao: em_dia, atrasado (venceu e a prorrogação ainda segura o acesso), bloqueado (passou a prorrogação), teste ou teste_expirado (plano de valor zero). Regra de negócio volta como DADO, nunca como erro: quando algo não está disponível o bloco vem com disponivel: false, motivo (identificador estável) e orientacao (o que dizer ao cliente) — repasse a orientacao em vez de inventar. data.indisponivel só vem preenchido quando a empresa não tem plano vigente (motivo sem_plano). É a assinatura da PRÓPRIA empresa neste sistema, não os contratos que ela vende aos clientes dela.", "description": "Tabela de recursos e aplicativos contratáveis na modalidade da empresa com o valor mensal de tabela, ou — informando o recurso — quanto a mensalidade desta empresa sobe em cada periodicidade ao contratá-lo.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/renovacao": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar renovação do plano", "operationId": "core_conta_renovacao_listar", "x-modulo": "core", "x-recurso": "conta_renovacao", "x-operacao": "listar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "empresa": { "type": "object", "properties": { "nome": { "type": "string" } } }, "plano": { "type": "object", "properties": { "nome": { "type": "string" }, "periodo": { "type": "string" }, "vencimento": { "type": "string" }, "situacao": { "type": "string" }, "forma_pagamento": { "type": "string" }, "dias_para_vencimento": { "type": "integer" }, "renovacao_automatica": { "type": "boolean" } } }, "recurso_adicional": { "type": "object", "properties": { "disponivel": { "type": "boolean" }, "caminho": { "type": "string" } } }, "recursos_contratados": { "type": "array", "items": { "type": "object", "properties": { "referencia": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "quantidade": { "type": "integer" } } } }, "indisponivel": { "type": [ "string", "null" ] } } } } }, "example": { "code": 200, "status": "success", "meta": { "cache": false }, "data": { "empresa": { "nome": "MENU TECNOLOGIA - Fantasia" }, "plano": { "nome": "Prata", "periodo": "mensal", "vencimento": "2026-11-09", "situacao": "em_dia", "forma_pagamento": "não definida", "dias_para_vencimento": 13, "renovacao_automatica": false }, "recurso_adicional": { "disponivel": true, "caminho": "Configurações › Meu plano › Contratar recurso" }, "recursos_contratados": [ { "referencia": "usuarios", "nome": "Usuários", "tipo": "recurso", "quantidade": 25 }, { "referencia": "lojas", "nome": "Lojas", "tipo": "recurso", "quantidade": 25 }, { "referencia": "boletos", "nome": "Emitir boletos", "tipo": "recurso", "quantidade": 1 }, { "referencia": "notas_fiscais", "nome": "Emitir notas fiscais", "tipo": "recurso", "quantidade": 1 }, { "referencia": "webdesk", "nome": "Área do Cliente", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "dominio", "nome": "Layout e domínio personalizado", "tipo": "recurso", "quantidade": 1 }, { "referencia": "gerencia_net", "nome": "GerenciaNet", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "pag_seguro", "nome": "Pag Seguro", "tipo": "aplicativo", "quantidade": 2 }, { "referencia": "mercado_pago", "nome": "Mercado Pago", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "pag_hiper", "nome": "PagHiper", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "pipedrive", "nome": "Pipedrive", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "send_grid", "nome": "SendGrid", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "nuvem_shop", "nome": "NuvemShop", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "mercado_livre", "nome": "Mercado Livre", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "loja_integrada", "nome": "Loja Integrada", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "cobrancas", "nome": "Cobranças", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "integracao_api", "nome": "API", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "banco_inter", "nome": "Banco Inter", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "ecommerce", "nome": "Loja Virtual", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "assinatura_digital", "nome": "Assinatura Digital", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "cora", "nome": "Cora", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "iugu", "nome": "Iugu", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "expedicao", "nome": "Expedição", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "tray", "nome": "Tray", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "cte", "nome": "Ct-e", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "mdfe", "nome": "MDF-e", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "controle_producao", "nome": "Controle de Produção", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "crm", "nome": "CRM", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "controle_bens", "nome": "Controle de Benas", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "shopee", "nome": "Shopee", "tipo": "aplicativo", "quantidade": 1 }, { "referencia": "recursos_humanos", "nome": "RH", "tipo": "aplicativo", "quantidade": 1 } ], "indisponivel": null } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "Use quando perguntarem quando vence, se está em dia ou se dá para contratar algo a mais. data.plano.dias_para_vencimento é negativo quando já venceu. data.recurso_adicional diz se dá para contratar recurso separado AGORA: exige plano pago em dia com mais de 10 dias até o vencimento; com menos, o recurso entra junto com a renovação (motivo vence_em_menos_de_10_dias). data.recursos_contratados: tipo aplicativo ou recurso; quantidade é o limite (usuários, lojas) ou, nos sim/não, o número de lojas com o recurso. Para valores, use /conta/precos_recursos e /conta/simulacao; para o boleto, /conta/boleto. data.plano.situacao: em_dia, atrasado (venceu e a prorrogação ainda segura o acesso), bloqueado (passou a prorrogação), teste ou teste_expirado (plano de valor zero). Regra de negócio volta como DADO, nunca como erro: quando algo não está disponível o bloco vem com disponivel: false, motivo (identificador estável) e orientacao (o que dizer ao cliente) — repasse a orientacao em vez de inventar. data.indisponivel só vem preenchido quando a empresa não tem plano vigente (motivo sem_plano). É a assinatura da PRÓPRIA empresa neste sistema, não os contratos que ela vende aos clientes dela.", "description": "Situação da renovação da assinatura deste sistema: plano vigente, dias para o vencimento, renovação automática, se dá para contratar recurso adicional agora e os recursos e aplicativos contratados. Mesma regra do atendimento de renovação (PlanoRenovacaoComponent).\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/conta/simulacao": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar simulação de periodicidade", "operationId": "core_conta_simulacao_listar", "x-modulo": "core", "x-recurso": "conta_simulacao", "x-operacao": "listar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "empresa": { "type": "object", "properties": { "nome": { "type": "string" } } }, "plano": { "type": "object", "properties": { "nome": { "type": "string" }, "periodo": { "type": "string" }, "vencimento": { "type": "string" }, "situacao": { "type": "string" }, "forma_pagamento": { "type": "string" } } }, "simulacao": { "type": "object", "properties": { "disponivel": { "type": "boolean" }, "motivo": { "type": "string" }, "orientacao": { "type": "string" } } }, "indisponivel": { "type": [ "string", "null" ] } } } } }, "example": { "code": 200, "status": "success", "meta": { "cache": false }, "data": { "empresa": { "nome": "MENU TECNOLOGIA - Fantasia" }, "plano": { "nome": "Prata", "periodo": "mensal", "vencimento": "2026-11-09", "situacao": "em_dia", "forma_pagamento": "não definida" }, "simulacao": { "disponivel": false, "motivo": "falha_calculo", "orientacao": "Não foi possível calcular os valores agora. Os valores aparecem em Configurações › Meu plano, ao contratar ou renovar." }, "indisponivel": null } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Planos/meu_plano", "x-ia": "data.simulacao.periodos.: meses, desconto (%), valor_por_mes e valor_total do período, com reajuste e cupom da empresa. data.simulacao.historico_mensal: meses_pagos e total_pago da sequência mensal mais recente (até 12 pagamentos) e, em comparacao, teria_pago e teria_economizado em cada periodicidade. São só números: não prometa desconto além deles. Plano de teste (valor zero) vem com disponivel false e motivo plano_teste. data.plano.situacao: em_dia, atrasado (venceu e a prorrogação ainda segura o acesso), bloqueado (passou a prorrogação), teste ou teste_expirado (plano de valor zero). Regra de negócio volta como DADO, nunca como erro: quando algo não está disponível o bloco vem com disponivel: false, motivo (identificador estável) e orientacao (o que dizer ao cliente) — repasse a orientacao em vez de inventar. data.indisponivel só vem preenchido quando a empresa não tem plano vigente (motivo sem_plano). É a assinatura da PRÓPRIA empresa neste sistema, não os contratos que ela vende aos clientes dela.", "description": "O plano atual (mesmo plano e mesmos recursos) em cada periodicidade — mensal, trimestral, semestral e anual — com o desconto de cada uma, e quanto os últimos pagamentos mensais teriam custado em outra periodicidade.\n\n**Permissão exigida:** `Planos/meu_plano` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/etiquetas": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar modelos de etiqueta", "operationId": "core_etiquetas_listar", "x-modulo": "core", "x-recurso": "etiquetas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome do modelo (busca parcial)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" }, "tipo_papel": { "type": "string" }, "tipo_papel_descricao": { "type": "string" }, "largura": { "type": "number" }, "altura": { "type": "number" }, "colunas": { "type": "integer" }, "linhas": { "type": "integer" }, "possui_layout": { "type": "boolean" }, "campos_layout": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "itens": [ { "id": "22703", "nome": "Teste GCK-22578 PIMACO - 3080/3180", "padrao": "", "tipo_papel": "carta", "tipo_papel_descricao": "Carta - 21,59 X 27,94 cm", "largura": 6.6699999999999999289457264239899814128875732421875, "altura": 2.54000000000000003552713678800500929355621337890625, "colunas": 3, "linhas": 10, "possui_layout": false, "campos_layout": "Nome, Código interno, Valor", "modificado_em": "2026-10-27 19:07:04" }, { "id": "22704", "nome": "Teste GCK-22578 PIMACO - 3082/3182", "padrao": "", "tipo_papel": "carta", "tipo_papel_descricao": "Carta - 21,59 X 27,94 cm", "largura": 10.160000000000000142108547152020037174224853515625, "altura": 3.390000000000000124344978758017532527446746826171875, "colunas": 2, "linhas": 7, "possui_layout": false, "campos_layout": "Nome, Código interno, Valor", "modificado_em": "2026-10-27 19:07:04" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Etiquetas/index", "x-ia": "São os MODELOS (o formato do papel e o desenho), não as etiquetas impressas: a impressão é feita pelo usuário na tela Produtos › Etiquetas › Gerar etiquetas, escolhendo o modelo e os produtos — a API não gera o PDF. Os formatos prontos (PIMACO etc.) do cadastro não aparecem aqui: só entram quando o usuário salva um modelo a partir deles. campos_layout é o texto do que sai na etiqueta, na ordem; possui_layout true = desenhado no editor visual (senão, desenho padrão pelas opções exibir_*). data.itens é só uma página (pagina/limite, até 100); a lista vem sempre em ordem de nome — ordenacao/direcao não têm efeito aqui.", "description": "Os modelos de etiqueta de produto cadastrados na empresa (Produtos › Etiquetas), só leitura: papel, medidas, grade de colunas × linhas, fonte e o que sai impresso. A listagem traz o resumo; o detalhe traz as margens, a fonte e a calibração.\n\n**Permissão exigida:** `Etiquetas/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/etiquetas/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar modelos de etiqueta", "operationId": "core_etiquetas_visualizar", "x-modulo": "core", "x-recurso": "etiquetas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" }, "descricao": { "type": "string" }, "tipo_papel": { "type": "string" }, "tipo_papel_descricao": { "type": "string" }, "largura_papel": { "type": [ "string", "null" ] }, "altura_papel": { "type": [ "string", "null" ] }, "largura": { "type": "number" }, "altura": { "type": "number" }, "colunas": { "type": "integer" }, "linhas": { "type": "integer" }, "maximo_colunas": { "type": "integer" }, "margem_superior": { "type": "number" }, "margem_lateral": { "type": "number" }, "densidade_vertical": { "type": "number" }, "densidade_horizontal": { "type": "number" }, "nome_fonte": { "type": "string" }, "tamanho_fonte": { "type": "integer" }, "tamanho_fonte_valor": { "type": [ "string", "null" ] }, "limite_caracteres": { "type": [ "string", "null" ] }, "exibir_codigo": { "type": "integer" }, "exibir_valor": { "type": "integer" }, "exibir_codigo_barra": { "type": "integer" }, "exibir_numero_codigo_barra": { "type": "integer" }, "posicao_codigo_barras": { "type": "integer" }, "exibir_lote": { "type": "integer" }, "exibir_data_fabricacao": { "type": "integer" }, "exibir_data_validade": { "type": "integer" }, "possui_layout": { "type": "boolean" }, "campos_layout": { "type": "string" }, "deslocamento_horizontal": { "type": "integer" }, "deslocamento_vertical": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "22703", "nome": "Teste GCK-22578 PIMACO - 3080/3180", "padrao": "", "descricao": "", "tipo_papel": "carta", "tipo_papel_descricao": "Carta - 21,59 X 27,94 cm", "largura_papel": null, "altura_papel": null, "largura": 6.6699999999999999289457264239899814128875732421875, "altura": 2.54000000000000003552713678800500929355621337890625, "colunas": 3, "linhas": 10, "maximo_colunas": 7, "margem_superior": 1.270000000000000017763568394002504646778106689453125, "margem_lateral": 0.479999999999999982236431605997495353221893310546875, "densidade_vertical": 2.54000000000000003552713678800500929355621337890625, "densidade_horizontal": 6.980000000000000426325641456060111522674560546875, "nome_fonte": "Helvetica", "tamanho_fonte": 8, "tamanho_fonte_valor": null, "limite_caracteres": null, "exibir_codigo": 1, "exibir_valor": 1, "exibir_codigo_barra": 0, "exibir_numero_codigo_barra": 0, "posicao_codigo_barras": 2, "exibir_lote": 0, "exibir_data_fabricacao": 0, "exibir_data_validade": 0, "possui_layout": false, "campos_layout": "Nome, Código interno, Valor", "deslocamento_horizontal": 0, "deslocamento_vertical": 0, "cadastrado_em": "2026-10-27 19:07:04", "modificado_em": "2026-10-27 19:07:04" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Etiquetas/visualizar", "x-ia": "404 também para modelo de outra empresa. Medidas da etiqueta e do papel (largura, altura, margem_*, densidade_* = distância entre o início de uma etiqueta e o da próxima) em centímetros; deslocamento_horizontal/vertical é a calibração da impressora, em milímetros. exibir_* 1 = o campo sai impresso; posicao_codigo_barras é a posição do código de barras no desenho padrão. O desenho do editor visual (posição de cada campo) não sai.", "description": "**Permissão exigida:** `Etiquetas/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/grades": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar grades de variação", "operationId": "core_grades_listar", "x-modulo": "core", "x-recurso": "grades", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 4, "total_paginas": 1, "total_registros_pagina": 4, "pagina_atual": 1, "limite_por_pagina": 5, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "308881", "nome": "2 Cores", "cadastrado_em": "2025-04-09 13:36:47" }, { "id": "308880", "nome": "Cor", "cadastrado_em": "2025-04-09 13:36:47" }, { "id": "308879", "nome": "Gênero", "cadastrado_em": "2025-04-09 13:36:46" }, { "id": "308882", "nome": "Tamanho", "cadastrado_em": "2025-04-09 13:36:47" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Grades são os tipos de variação (Tamanho, Cor…) e as opções de cada uma, da empresa toda; o detalhe (/grades/{id}) traz as opções em variacoes. As variações de cada produto, com estoque e preço, estão em /produtos (variacoes).", "description": "`tipo`: 0 = opções em texto (ex.: P, M, G), 1 = cor, 2 = duas cores. Nas grades de cor o `nome` da variação é o código da cor (ex.: `#1717FF`, ou `#1717FF:#666666` na de duas cores). Pela API a grade é sempre criada como texto (`tipo` 0).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar grades de variação", "operationId": "core_grades_cadastrar", "x-modulo": "core", "x-recurso": "grades", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "object", "properties": { "variacao": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "grade_id": { "type": "string" }, "nome": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "308902", "empresa_id": "24", "nome": "Cor API 761761", "tipo": "0", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:47", "modificado_em": "2026-10-29 11:41:47", "variacoes": [ { "variacao": { "id": "6243542", "empresa_id": "24", "grade_id": "308902", "nome": "Azul", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:47", "modificado_em": "2026-10-29 11:41:47" } }, { "variacao": { "id": "6243543", "empresa_id": "24", "grade_id": "308902", "nome": "Verde", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:47", "modificado_em": "2026-10-29 11:41:47" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`Variacao` é a lista das opções da grade, cada uma com `nome` (ex.: `[{\"nome\":\"Azul\"},{\"nome\":\"Verde\"}]`). A chave é escrita assim mesmo, com V maiúsculo. Nomes repetidos na mesma grade são recusados (400). O retorno vem como lista com um item (`data[0].id`).\n\n**Campos obrigatórios:** `nome`, `Variacao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "Variacao": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Cor API 761761", "Variacao": [ { "nome": "Azul" }, { "nome": "Verde" } ] } } } } } }, "/grades/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar grades de variação", "operationId": "core_grades_visualizar", "x-modulo": "core", "x-recurso": "grades", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "object", "properties": { "variacao": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "grade_id": { "type": "string" }, "nome": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "308881", "empresa_id": "24", "nome": "2 Cores", "tipo": "2", "usuario_id": "", "nome_usuario": "", "cadastrado_em": "2025-04-09 13:36:47", "modificado_em": "2025-04-09 13:36:47", "variacoes": [ { "variacao": { "id": "6243428", "empresa_id": "24", "grade_id": "308881", "nome": "#1717FF:#666666", "usuario_id": "", "nome_usuario": "", "cadastrado_em": "2025-04-09 13:36:47", "modificado_em": "2025-04-09 13:36:47" } }, { "variacao": { "id": "6243429", "empresa_id": "24", "grade_id": "308881", "nome": "#000000:#990000", "usuario_id": "", "nome_usuario": "", "cadastrado_em": "2025-04-09 13:36:47", "modificado_em": "2025-04-09 13:36:47" } }, { "variacao": { "id": "6243430", "empresa_id": "24", "grade_id": "308881", "nome": "#741B47:#FF9900", "usuario_id": "", "nome_usuario": "", "cadastrado_em": "2025-04-09 13:36:47", "modificado_em": "2025-04-09 13:36:47" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar grades de variação", "operationId": "core_grades_editar", "x-modulo": "core", "x-recurso": "grades", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "variacoes": { "type": "array", "items": { "type": "object", "properties": { "variacao": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "grade_id": { "type": "string" }, "nome": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "308902", "empresa_id": "24", "nome": "Cor API 761761 editada", "tipo": "0", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:47", "modificado_em": "2026-10-29 11:41:47", "variacoes": [ { "variacao": { "id": "6243544", "empresa_id": "24", "grade_id": "308902", "nome": "Azul", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:47", "modificado_em": "2026-10-29 11:41:47" } }, { "variacao": { "id": "6243545", "empresa_id": "24", "grade_id": "308902", "nome": "Vermelho", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:47", "modificado_em": "2026-10-29 11:41:47" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Envie a lista `Variacao` completa: ela substitui as opções da grade.\n\n**Campos obrigatórios:** `nome`, `Variacao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "Variacao": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Cor API 761761 editada", "Variacao": [ { "nome": "Azul" }, { "nome": "Vermelho" } ] } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar grades de variação", "operationId": "core_grades_deletar", "x-modulo": "core", "x-recurso": "grades", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Grade removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/grupos_servicos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar grupos de serviços", "operationId": "core_grupos_servicos_listar", "x-modulo": "core", "x-recurso": "grupos_servicos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "grupo_pai_id": { "type": "string" }, "nome": { "type": "string" }, "url": { "type": "string" }, "meta_palavras_chaves": { "type": "string" }, "meta_descricao": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 3, "total_paginas": 1, "total_registros_pagina": 3, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "807377", "grupo_pai_id": "", "nome": "Serviços IA 151006", "url": "servicos-ia-151006", "meta_palavras_chaves": "", "meta_descricao": "" }, { "id": "807379", "grupo_pai_id": "", "nome": "Serviços IA 151030", "url": "servicos-ia-151030", "meta_palavras_chaves": "", "meta_descricao": "" }, { "id": "807381", "grupo_pai_id": "", "nome": "Serviços IA 151043", "url": "servicos-ia-151043", "meta_palavras_chaves": "", "meta_descricao": "" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Grupos do catálogo de serviços (separados dos grupos de produtos), da empresa toda, em ordem de nome. A listagem de /servicos não filtra por grupo.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/grupos_servicos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar grupos de serviços", "operationId": "core_grupos_servicos_visualizar", "x-modulo": "core", "x-recurso": "grupos_servicos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "grupo_pai_id": { "type": "string" }, "nome": { "type": "string" }, "url": { "type": "string" }, "meta_palavras_chaves": { "type": "string" }, "meta_descricao": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "807377", "grupo_pai_id": "", "nome": "Serviços IA 151006", "url": "servicos-ia-151006", "meta_palavras_chaves": "", "meta_descricao": "" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/grupos_usuarios": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar grupos de permissões de usuários", "operationId": "core_grupos_usuarios_listar", "x-modulo": "core", "x-recurso": "grupos_usuarios", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": "integer" }, "proxima_url": { "type": "string" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "master": { "type": "string" }, "verificado": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 21, "total_paginas": 2, "total_registros_pagina": 20, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": 2, "proxima_url": "/api/grupos_usuarios?pagina=2" }, "data": [ { "id": "27", "nome": "Administração", "master": "1", "verificado": "1" }, { "id": "85091", "nome": "Grupo 2", "master": "0", "verificado": "1" }, { "id": "85134", "nome": "normal a", "master": "0", "verificado": "0" }, { "id": "85160", "nome": "Administração", "master": "0", "verificado": "0" }, { "id": "85164", "nome": "Grupo teste 1", "master": "0", "verificado": "0" }, { "id": "85165", "nome": "Grupo Teste 2", "master": "0", "verificado": "0" }, { "id": "85269", "nome": "Adicionar", "master": "0", "verificado": "0" }, { "id": "85270", "nome": "exclusão", "master": "0", "verificado": "0" }, { "id": "85332", "nome": "Lolan", "master": "0", "verificado": "0" }, { "id": "85345", "nome": "Grupo_Test_de_Permissoes", "master": "0", "verificado": "0" }, { "id": "85347", "nome": "Nasclolan", "master": "0", "verificado": "0" }, { "id": "85399", "nome": "novo_grupo", "master": "0", "verificado": "0" }, { "id": "85421", "nome": "Mina", "master": "0", "verificado": "0" }, { "id": "85593", "nome": "Grupo test banco Inter", "master": "0", "verificado": "0" }, { "id": "85594", "nome": "Zero", "master": "0", "verificado": "0" }, { "id": "85595", "nome": "grupinho", "master": "0", "verificado": "0" }, { "id": "85596", "nome": "Teste ADS", "master": "0", "verificado": "0" }, { "id": "85597", "nome": "Bco Inter", "master": "0", "verificado": "0" }, { "id": "85598", "nome": "GRUPO USUARIOS IUGU", "master": "0", "verificado": "0" }, { "id": "85797", "nome": "Hotmart", "master": "0", "verificado": "0" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Só os nomes dos grupos (perfis de permissão): as permissões de cada grupo não saem pela API. master 1 = grupo principal da conta (não pode ser excluído). Para saber quem está em cada grupo, filtre /usuarios por grupo_id.", "description": "Grupos de permissões da tela Configurações > Permissões. O `grupo_id` de `/usuarios` aponta para cá.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/marcas_produtos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar marcas de produtos", "operationId": "core_marcas_produtos_listar", "x-modulo": "core", "x-recurso": "marcas_produtos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "logomarca": { "type": "string" }, "descricao": { "type": "string" }, "ativo": { "type": "string" }, "destaque_loja_virtual": { "type": "string" }, "meta_palavras_chaves": { "type": "string" }, "meta_descricao": { "type": "string" }, "url": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 3, "total_paginas": 1, "total_registros_pagina": 3, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "99", "empresa_id": "24", "nome": "Marca IA 151006", "logomarca": "", "descricao": "", "ativo": "1", "destaque_loja_virtual": "0", "meta_palavras_chaves": "", "meta_descricao": "", "url": "marca-ia-151006", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-28 15:10:06", "modificado_em": "2026-10-28 15:10:06" }, { "id": "100", "empresa_id": "24", "nome": "Marca IA 151030", "logomarca": "", "descricao": "", "ativo": "1", "destaque_loja_virtual": "0", "meta_palavras_chaves": "", "meta_descricao": "", "url": "marca-ia-151030", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-28 15:10:30", "modificado_em": "2026-10-28 15:10:30" }, { "id": "101", "empresa_id": "24", "nome": "Marca IA 151043", "logomarca": "", "descricao": "", "ativo": "1", "destaque_loja_virtual": "0", "meta_palavras_chaves": "", "meta_descricao": "", "url": "marca-ia-151043", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-28 15:10:43", "modificado_em": "2026-10-28 15:10:43" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Marcas cadastradas para a loja da chave (loja_id escolhe outra loja). /produtos não filtra por marca: marca_id é ignorado lá.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/marcas_produtos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar marcas de produtos", "operationId": "core_marcas_produtos_visualizar", "x-modulo": "core", "x-recurso": "marcas_produtos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "logomarca": { "type": "string" }, "descricao": { "type": "string" }, "ativo": { "type": "string" }, "destaque_loja_virtual": { "type": "string" }, "meta_palavras_chaves": { "type": "string" }, "meta_descricao": { "type": "string" }, "url": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "99", "empresa_id": "24", "nome": "Marca IA 151006", "logomarca": "", "descricao": "", "ativo": "1", "destaque_loja_virtual": "0", "meta_palavras_chaves": "", "meta_descricao": "", "url": "marca-ia-151006", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-28 15:10:06", "modificado_em": "2026-10-28 15:10:06" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/aniversariantes": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar aniversariantes", "operationId": "core_relatorio_aniversariantes_listar", "x-modulo": "core", "x-recurso": "relatorio_aniversariantes", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "mes", "in": "query", "required": false, "description": "int — mês do aniversário, de 1 a 12; vários separados por vírgula (ex.: 3,4). Sem ele vêm todos os meses", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome ou razão social (busca parcial)", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — telefone ou celular", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço (ex.: SP)", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": [ "string", "null" ] }, "inscricao_estadual": { "type": [ "string", "null" ] }, "inscricao_municipal": { "type": [ "string", "null" ] }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "nome_social": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "ativo": { "type": "integer" }, "telefone": { "type": [ "string", "null" ] }, "celular": { "type": "string" }, "fax": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "observacoes": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "endereco": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 3, "pagina": 1, "limite": 2, "total_paginas": 2, "cache": false }, "data": { "totais": { "quantidade": 3 }, "itens": [ { "id": "58689", "nome": "Maria Teste", "tipo_pessoa": "PF", "razao_social": null, "cnpj": null, "inscricao_estadual": null, "inscricao_municipal": null, "cpf": null, "rg": null, "nome_social": null, "data_nascimento": null, "ativo": 1, "telefone": null, "celular": "(31) 99999-0000", "fax": null, "email": null, "observacoes": null, "cadastrado_em": "2026-10-26 14:55:06", "endereco": null }, { "id": "58690", "nome": "Joao Teste", "tipo_pessoa": "PF", "razao_social": null, "cnpj": null, "inscricao_estadual": null, "inscricao_municipal": null, "cpf": "529.982.247-25", "rg": null, "nome_social": null, "data_nascimento": null, "ativo": 1, "telefone": null, "celular": null, "fax": null, "email": null, "observacoes": null, "cadastrado_em": "2026-10-26 14:55:07", "endereco": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Clientes/gerar_relatorios", "x-ia": "Só clientes pessoa física (PF). Com mes, só quem tem data de nascimento naquele mês; sem mes vêm todos os PF, inclusive sem data (data_nascimento null). data_nascimento em AAAA-MM-DD: o aniversário é dia e mês, o ano é o de nascimento. data.totais.quantidade é o total de cadastros que passaram no filtro; data.itens é só uma página (até 100): para contar, use o total, nunca as linhas — e pagine com pagina para listar tudo.", "description": "Clientes pessoa física ordenados por mês e dia de aniversário, com filtro pelo mês. É a mesma regra do relatório de aniversariantes da tela.\n\n**Permissão exigida:** `Clientes/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/clientes": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar relatório de clientes", "operationId": "core_relatorio_clientes_listar", "x-modulo": "core", "x-recurso": "relatorio_clientes", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome ou razão social (busca parcial)", "schema": { "type": "string" } }, { "name": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = estrangeiro", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — telefone ou celular", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço (ex.: SP)", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — vendedor responsável (só filtra se o usuário da chave tiver a permissão de ver clientes de outros vendedores)", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros, sem teto de período", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia (data de cadastro)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "nome": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "limitado": { "type": "boolean" }, "limite": { "type": [ "string", "null" ] } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": [ "string", "null" ] }, "inscricao_municipal": { "type": [ "string", "null" ] }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "nome_social": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "ativo": { "type": "integer" }, "telefone": { "type": "string" }, "celular": { "type": [ "string", "null" ] }, "fax": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "vendedor": { "type": "string" }, "observacoes": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "endereco": { "type": "object", "properties": { "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cep": { "type": "string" }, "cidade": { "type": "string" }, "estado": { "type": "string" } } }, "campos_extras": { "type": "object", "properties": { "TESTE GCK-22596 Segmento": { "type": "string" }, "TESTE GCK-22596 Codigo ERP antigo": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "nome": "Oficina Exemplo" }, "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": true }, "data": { "totais": { "quantidade": 1, "limitado": false, "limite": null }, "itens": [ { "id": "58688", "nome": "Oficina Exemplo", "tipo_pessoa": "PJ", "razao_social": null, "cnpj": "44.555.666/0001-03", "inscricao_estadual": null, "inscricao_municipal": null, "cpf": null, "rg": null, "nome_social": null, "data_nascimento": null, "ativo": 1, "telefone": "(31) 3333-4444", "celular": null, "fax": null, "email": null, "vendedor": "João do BD COMPARTILHADO!", "observacoes": null, "cadastrado_em": "2026-10-26 14:55:06", "endereco": { "logradouro": "Avenida Paulista", "numero": "5", "complemento": "de 612 a 1510 - lado par", "bairro": "Bela Vista", "cep": "01310-100", "cidade": "São Paulo", "estado": "SP" }, "campos_extras": { "TESTE GCK-22596 Segmento": "Oficina mecanica", "TESTE GCK-22596 Codigo ERP antigo": "A-1020" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Clientes/gerar_relatorios", "x-periodo": { "data": "a data de cadastro do cliente (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Use para listar, contar ou exportar clientes por critério (cidade, UF, situação, PF/PJ, vendedor, cadastrados num período). Para achar UM cliente, ver o cadastro completo, editar ou cadastrar use /clientes (CRUD) — este relatório é só leitura, sem contatos adicionais, e traz um endereço por cliente. campos_extras = os campos extras de cliente cadastrados pela empresa, {nome do campo: conteúdo} (null quando o cliente não tem nenhum preenchido); vêm só nas linhas da página devolvida. data.totais.quantidade é o total de cadastros que passaram no filtro; data.itens é só uma página (até 100): para contar, use o total, nunca as linhas — e pagine com pagina para listar tudo. Com mais de 10 campos extras de cliente cadastrados na empresa, a regra da tela corta o relatório em data.totais.limite linhas e data.totais.limitado vem true: avise que a lista está incompleta e filtre mais. Os dados pessoais (CPF, telefone, e-mail) são os que a tela mostra a quem tem a permissão.", "description": "Lista de clientes com documentos, contatos, vendedor, observações, endereço e campos extras, com filtros de pessoa, situação e data de cadastro. É a mesma regra do relatório de clientes da tela (Relatórios › Cadastros).\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do cliente (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.\n\n**Permissão exigida:** `Clientes/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/fornecedores": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar relatório de fornecedores", "operationId": "core_relatorio_fornecedores_listar", "x-modulo": "core", "x-recurso": "relatorio_fornecedores", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome ou razão social (busca parcial)", "schema": { "type": "string" } }, { "name": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = estrangeiro", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — trecho do telefone ou celular, SÓ OS DÍGITOS: com máscara, ex. (11)9773-..., não acha", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço (ex.: SP)", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros, sem teto de período", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia (data de cadastro)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "filtros": { "type": "object", "properties": { "nome": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": [ "string", "null" ] }, "inscricao_municipal": { "type": [ "string", "null" ] }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "ativo": { "type": "integer" }, "telefone": { "type": [ "string", "null" ] }, "celular": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "endereco": { "type": "object", "properties": { "logradouro": { "type": "string" }, "numero": { "type": "string" }, "complemento": { "type": "string" }, "bairro": { "type": "string" }, "cep": { "type": "string" }, "cidade": { "type": "string" }, "estado": { "type": "string" } } }, "campos_extras": { "type": "object", "properties": { "TESTE GCK-22596 Segmento": { "type": "string" }, "TESTE GCK-22596 Codigo ERP antigo": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "filtros": { "nome": "Fornecedor Teste" }, "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": true }, "data": { "totais": { "quantidade": 2 }, "itens": [ { "id": "561", "nome": "Fornecedor Teste", "tipo_pessoa": "PJ", "razao_social": null, "cnpj": "07.707.650/0001-10", "inscricao_estadual": null, "inscricao_municipal": null, "cpf": null, "rg": null, "data_nascimento": null, "ativo": 1, "telefone": null, "celular": null, "email": null, "cadastrado_em": "2026-10-26 14:55:07", "endereco": { "logradouro": "Avenida Paulista", "numero": "1000", "complemento": "de 612 a 1510 - lado", "bairro": "Bela Vista", "cep": "01310-100", "cidade": "São Paulo", "estado": "SP" }, "campos_extras": { "TESTE GCK-22596 Segmento": "Distribuidora", "TESTE GCK-22596 Codigo ERP antigo": "F-77" } }, { "id": "545", "nome": "Fornecedor Teste Claude", "tipo_pessoa": "PJ", "razao_social": null, "cnpj": null, "inscricao_estadual": null, "inscricao_municipal": null, "cpf": null, "rg": null, "data_nascimento": null, "ativo": 1, "telefone": null, "celular": null, "email": null, "cadastrado_em": "2026-09-21 13:57:24", "endereco": null, "campos_extras": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fornecedores/gerar_relatorios", "x-periodo": { "data": "a data de cadastro do fornecedor (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Fornecedor é da empresa inteira: não há filtro de loja. Para achar UM fornecedor, ver o cadastro completo ou editar use /fornecedores (CRUD); este relatório é para listar e contar por critério, com um endereço por fornecedor. campos_extras = os campos extras de fornecedor, {nome do campo: conteúdo} (null quando o fornecedor não tem nenhum preenchido); vêm só nas linhas da página devolvida. data.totais.quantidade é o total de cadastros que passaram no filtro; data.itens é só uma página (até 100): para contar, use o total, nunca as linhas — e pagine com pagina para listar tudo.", "description": "Lista de fornecedores com documentos, contatos, endereço e campos extras, com filtros de pessoa, situação e data de cadastro. É a mesma regra do relatório de fornecedores da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do fornecedor (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.\n\n**Permissão exigida:** `Fornecedores/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/funcionarios": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar relatório de funcionários", "operationId": "core_relatorio_funcionarios_listar", "x-modulo": "core", "x-recurso": "relatorio_funcionarios", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome (busca parcial)", "schema": { "type": "string" } }, { "name": "cpf", "in": "query", "required": false, "description": "string — CPF, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — telefone ou celular", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF", "schema": { "type": "string" } }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de usuários (ids em /grupos_usuarios)", "schema": { "type": "string" } }, { "name": "permite_acesso", "in": "query", "required": false, "description": "1 = só quem acessa o sistema, 0 = só quem não acessa. Sem a permissão de listar usuários, o relatório só traz quem não acessa, com ou sem este filtro", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros, sem teto de período", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia (data de cadastro)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "nome": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "email_secundario": { "type": "string" }, "telefone": { "type": [ "string", "null" ] }, "celular": { "type": [ "string", "null" ] }, "celular_2": { "type": [ "string", "null" ] }, "cpf": { "type": [ "string", "null" ] }, "rg": { "type": [ "string", "null" ] }, "data_nascimento": { "type": [ "string", "null" ] }, "sexo": { "type": [ "string", "null" ] }, "comissao_porcentagem": { "type": "integer" }, "desconto_maximo_porcentagem": { "type": "integer" }, "ativo": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "endereco": { "type": "object", "properties": { "cidade": { "type": "string" }, "estado": { "type": "string" } } }, "campos_extras": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "nome": "Funcionário editado" }, "total_registros": 1, "pagina": 1, "limite": 1, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 1 }, "itens": [ { "id": "130031", "nome": "Funcionário editado", "email": null, "email_secundario": "funcionarioteste@email.com", "telefone": null, "celular": null, "celular_2": null, "cpf": null, "rg": null, "data_nascimento": null, "sexo": null, "comissao_porcentagem": 50, "desconto_maximo_porcentagem": 100, "ativo": 1, "cadastrado_em": "2020-10-16 10:16:36", "endereco": { "cidade": "Abadiânia", "estado": "GO" }, "campos_extras": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Funcionarios/gerar_relatorios", "x-periodo": { "data": "a data de cadastro do funcionário (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Sem a permissão de listar usuários (Usuarios/index), o usuário da chave só vê funcionários sem acesso ao sistema — a lista pode parecer curta por isso. comissao_porcentagem e desconto_maximo_porcentagem são percentuais como gravados no cadastro. campos_extras vem {nome do campo: conteúdo}. Não traz senha nem permissões; para o cadastro completo use /funcionarios (CRUD). data.totais.quantidade é o total de cadastros que passaram no filtro; data.itens é só uma página (até 100): para contar, use o total, nunca as linhas — e pagine com pagina para listar tudo.", "description": "Lista de funcionários com documentos, contatos, comissão, desconto máximo, endereço e campos extras. É a mesma regra do relatório de funcionários da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do funcionário (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.\n\n**Permissão exigida:** `Funcionarios/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/produtos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar relatório de produtos", "operationId": "core_relatorio_produtos_listar", "x-modulo": "core", "x-recurso": "relatorio_produtos", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome do produto (todas as palavras)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código interno ou código de barras, do produto ou da variação", "schema": { "type": "string" } }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de produtos (inclui os subgrupos; ids em /grupos_produtos)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — produtos ligados a este fornecedor", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "situacao_estoque", "in": "query", "required": false, "description": "1 = estoque no mínimo ou abaixo, 2 = no máximo ou acima; sem ele independe. Mínimo/máximo em branco contam como 0: aí 1 pega todo estoque zero ou negativo e 2 pega todo estoque zero ou positivo", "schema": { "type": "string" } }, { "name": "localizacao", "in": "query", "required": false, "description": "string — localização no estoque (busca parcial)", "schema": { "type": "string" } }, { "name": "tipo_valor_id", "in": "query", "required": false, "description": "int — tabela de preço (ids em /tipos_valores_produtos); várias separadas por vírgula, até 10. Sem ele vêm todas as da loja", "schema": { "type": "string" } }, { "name": "exibir_fornecedor", "in": "query", "required": false, "description": "1 = acrescenta fornecedores (nomes separados por ' - '); deixa a consulta mais pesada", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "exibir_fornecedor": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "loja_id": { "type": "integer" }, "codigo": { "type": "string" }, "codigo_barra": { "type": "string" }, "nome": { "type": "string" }, "nome_variacao": { "type": "string" }, "grupo_id": { "type": [ "string", "null" ] }, "grupo": { "type": [ "string", "null" ] }, "movimenta_estoque": { "type": "integer" }, "estoque": { "type": "integer" }, "localizacao": { "type": [ "string", "null" ] }, "quantidade_saida": { "type": "integer" }, "ncm": { "type": [ "string", "null" ] }, "cest": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "valor_custo": { "type": "integer" }, "fornecedores": { "type": "string" }, "valores_venda": { "type": "array", "items": { "type": "object", "properties": { "tipo_id": { "type": "string" }, "tipo": { "type": "string" }, "valor_venda": { "type": "integer" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "exibir_fornecedor": "1" }, "total_registros": 5, "pagina": 1, "limite": 2, "total_paginas": 3, "cache": false }, "data": { "totais": { "quantidade": 5 }, "itens": [ { "produto_id": "31998", "loja_id": 80154, "codigo": "2050460512009", "codigo_barra": "2000129950406", "nome": "Coca cola", "nome_variacao": "Coca cola", "grupo_id": null, "grupo": null, "movimenta_estoque": 1, "estoque": 0, "localizacao": null, "quantidade_saida": 1, "ncm": null, "cest": null, "cadastrado_em": "2026-09-21 10:00:46", "valor_custo": 10, "fornecedores": "Fornecedor Teste Claude", "valores_venda": [ { "tipo_id": "91657", "tipo": "Padrão", "valor_venda": 15 } ] }, { "produto_id": "31998", "loja_id": 80542, "codigo": "2050460512009", "codigo_barra": "2000129950406", "nome": "Coca cola", "nome_variacao": "Coca cola", "grupo_id": null, "grupo": null, "movimenta_estoque": 1, "estoque": 0, "localizacao": null, "quantidade_saida": 1, "ncm": null, "cest": null, "cadastrado_em": "2026-09-21 10:00:46", "valor_custo": 10, "fornecedores": "Fornecedor Teste Claude", "valores_venda": [ { "tipo_id": "91657", "tipo": "Padrão", "valor_venda": 15 } ] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Produtos/gerar_relatorios", "x-ia": "Uma linha por VARIAÇÃO e LOJA (loja_id): o mesmo produto aparece uma vez por variação em cada loja — para contar produtos distintos use produto_id, e filtre loja_id para o estoque de uma loja. estoque é a quantidade da variação naquela loja (pode ser negativa). valores_venda: um item por tabela de preço (tipo_id, tipo, valor_venda; null = sem preço nessa tabela). valor_custo só vem para quem tem a permissão de ver custo (Produtos/visualizar_valor_custo). Para o cadastro completo, um produto só, ou edição, use /produtos (CRUD); para estoque por período ou movimentação use os relatórios de estoque. data.totais.quantidade é o total de cadastros que passaram no filtro; data.itens é só uma página (até 100): para contar, use o total, nunca as linhas — e pagine com pagina para listar tudo. Filtro que não está na lista (ex.: busca) é ignorado sem erro: confira meta.filtros, que ecoa só os aplicados.", "description": "Catálogo de produtos por variação e loja, com código, grupo, estoque, localização, NCM/CEST, custo e valores de venda por tabela de preço. É a mesma regra do relatório de produtos da tela (Relatórios › Cadastros).\n\n**Permissão exigida:** `Produtos/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/transportadoras": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Consultar relatório de transportadoras", "operationId": "core_relatorio_transportadoras_listar", "x-modulo": "core", "x-recurso": "relatorio_transportadoras", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — nome ou razão social (busca parcial)", "schema": { "type": "string" } }, { "name": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = estrangeiro", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ, com ou sem pontuação (busca parcial)", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — telefone ou celular", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int — cidade do endereço (ids em /cidades)", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string — UF do endereço (ex.: SP)", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados a partir deste dia (data de cadastro). Opcional: sem data_inicio/data_fim entram todos os cadastros, sem teto de período", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — cadastrados até este dia (data de cadastro)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "razao_social": { "type": [ "string", "null" ] }, "cnpj": { "type": [ "string", "null" ] }, "cpf": { "type": [ "string", "null" ] }, "ativo": { "type": "integer" }, "telefone": { "type": [ "string", "null" ] }, "celular": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 1 }, "itens": [ { "id": "264", "nome": "Correios", "tipo_pessoa": "PF", "razao_social": null, "cnpj": null, "cpf": null, "ativo": 1, "telefone": null, "celular": null, "email": null, "cadastrado_em": "2026-09-24 11:40:53" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Transportadoras/gerar_relatorios", "x-periodo": { "data": "a data de cadastro da transportadora (data_inicio/data_fim)", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Transportadora é da empresa inteira: não há filtro de loja. O telefone filtra pelo número exato (como na tela). Para o cadastro completo, endereço e edição use /transportadoras (CRUD). data.totais.quantidade é o total de cadastros que passaram no filtro; data.itens é só uma página (até 100): para contar, use o total, nunca as linhas — e pagine com pagina para listar tudo.", "description": "Lista de transportadoras com documento e contatos, com filtros de pessoa, situação e data de cadastro. É a mesma regra do relatório de transportadoras da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro da transportadora (data_inicio/data_fim). Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.\n\n**Permissão exigida:** `Transportadoras/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/tipos_valores_produtos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar tabelas de preço (tipos de valor)", "operationId": "core_tipos_valores_produtos_listar", "x-modulo": "core", "x-recurso": "tipos_valores_produtos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "TiposValoresProduto": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "lucro": { "type": "string" }, "padrao": { "type": "string" }, "padrao_loja_virtual": { "type": "string" }, "ordem": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_paginas": 1, "total_registros_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "TiposValoresProduto": { "id": "91657", "empresa_id": "24", "nome": "Padrão", "lucro": "50.00", "padrao": "0", "padrao_loja_virtual": "1", "ordem": "1", "usuario_id": "130854", "nome_usuario": "Usuário", "cadastrado_em": "2026-09-21 10:00:27" } } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Antes de responder um preço, saiba de qual tabela o cliente fala: cada produto tem um preço por tabela em /produtos (valores[].tipo_id = id daqui). padrao 1 = a tabela padrão. Lista as tabelas ligadas à loja da chave (loja_id escolhe outra).", "description": "São as tabelas de preço do produto (ex.: Atacado, Varejo). Apontam para cá o `valores[].tipo_id` de `/produtos` e o `tipo_valor_id` dos itens de vendas e orçamentos. `lucro` é a margem em %. A listagem vem no formato antigo, com cada item dentro de `TiposValoresProduto` (`data[].TiposValoresProduto.id`); o detalhe vem plano.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar tabelas de preço (tipos de valor)", "operationId": "core_tipos_valores_produtos_cadastrar", "x-modulo": "core", "x-recurso": "tipos_valores_produtos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "forma_utilizacao": { "type": "string" }, "lucro": { "type": "string" }, "padrao": { "type": "string" }, "padrao_loja_virtual": { "type": "string" }, "ordem": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "91677", "empresa_id": "24", "nome": "Tabela API 761761", "forma_utilizacao": "ILIMITADA", "lucro": "30.00", "padrao": "0", "padrao_loja_virtual": "0", "ordem": "2", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:45", "modificado_em": "2026-10-29 11:41:45" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "O retorno vem como lista com um item (`data[0].id`).\n\n**Campos obrigatórios:** `nome`, `lucro`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "lucro": { "type": "integer" } } }, "example": { "nome": "Tabela API 761761", "lucro": 30 } } } } } }, "/tipos_valores_produtos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar tabelas de preço (tipos de valor)", "operationId": "core_tipos_valores_produtos_visualizar", "x-modulo": "core", "x-recurso": "tipos_valores_produtos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "lucro": { "type": "string" }, "padrao": { "type": "string" }, "padrao_loja_virtual": { "type": "string" }, "ordem": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "91677", "empresa_id": "24", "nome": "Tabela API 761761", "lucro": "30.00", "padrao": "0", "padrao_loja_virtual": "0", "ordem": "2", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:45" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar tabelas de preço (tipos de valor)", "operationId": "core_tipos_valores_produtos_editar", "x-modulo": "core", "x-recurso": "tipos_valores_produtos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "forma_utilizacao": { "type": "string" }, "lucro": { "type": "string" }, "padrao": { "type": "string" }, "padrao_loja_virtual": { "type": "string" }, "ordem": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "91677", "empresa_id": "24", "nome": "Tabela API 761761 editada", "forma_utilizacao": "ILIMITADA", "lucro": "35.00", "padrao": "0", "padrao_loja_virtual": "0", "ordem": "2", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:45", "modificado_em": "2026-10-29 11:41:45" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `nome`, `lucro`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "lucro": { "type": "integer" } } }, "example": { "nome": "Tabela API 761761 editada", "lucro": 35 } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar tabelas de preço (tipos de valor)", "operationId": "core_tipos_valores_produtos_deletar", "x-modulo": "core", "x-recurso": "tipos_valores_produtos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Valor de venda removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/unidades_produtos": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Listar unidades de produtos", "operationId": "core_unidades_produtos_listar", "x-modulo": "core", "x-recurso": "unidades_produtos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "padrao": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_paginas": 1, "total_registros_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "484956", "nome": "Unidade", "sigla": "UN", "padrao": "0", "cadastrado_em": "2026-09-21 10:00:45" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Unidades de medida dos produtos da empresa (Unidade, Caixa, Quilograma…), em ordem de nome. sigla é a abreviação (UN, CX, KG); padrao 1 = a unidade padrão. O filtro é só por nome: sigla é ignorada.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Cadastrar unidades de produtos", "operationId": "core_unidades_produtos_cadastrar", "x-modulo": "core", "x-recurso": "unidades_produtos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "fracionado": { "type": "string" }, "padrao": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "484976", "empresa_id": "24", "nome": "Caixa API 761761", "sigla": "CX761761", "fracionado": "0", "padrao": "0", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:44", "modificado_em": "2026-10-29 11:41:44" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`sigla` é opcional (ex.: UND, CX). Nome repetido é recusado.\n\n**Campos obrigatórios:** `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "example": { "nome": "Caixa API 761761", "sigla": "CX761761" } } } } } }, "/unidades_produtos/{id}": { "get": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Visualizar unidades de produtos", "operationId": "core_unidades_produtos_visualizar", "x-modulo": "core", "x-recurso": "unidades_produtos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "fracionado": { "type": "string" }, "padrao": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "484956", "empresa_id": "24", "nome": "Unidade", "sigla": "UN", "fracionado": "0", "padrao": "0", "usuario_id": "130854", "nome_usuario": "Usuário", "cadastrado_em": "2026-09-21 10:00:45", "modificado_em": "2026-09-21 10:00:45" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Editar unidades de produtos", "operationId": "core_unidades_produtos_editar", "x-modulo": "core", "x-recurso": "unidades_produtos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "nome": { "type": "string" }, "sigla": { "type": "string" }, "fracionado": { "type": "string" }, "padrao": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "484976", "empresa_id": "24", "nome": "Caixa API 761761 edi", "sigla": "CX761761", "fracionado": "0", "padrao": "0", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 11:41:44", "modificado_em": "2026-10-29 11:41:44" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "sigla": { "type": "string" } } }, "example": { "nome": "Caixa API 761761 editada", "sigla": "CX761761" } } } } }, "delete": { "tags": [ "Cadastros, produtos e serviços" ], "summary": "Deletar unidades de produtos", "operationId": "core_unidades_produtos_deletar", "x-modulo": "core", "x-recurso": "unidades_produtos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Unidade de produtos removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/orcamentos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar orçamentos", "operationId": "pedidos_orcamentos_listar", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data do orçamento)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja (ids em /lojas); sem ele vem só a loja padrão da chave (a matriz, ou a primeira loja que o usuário acessa), não todas", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "produto = só orçamento de produto, servico = só orçamento de serviço; sem ele vêm os dois", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número do orçamento (o que aparece na tela; não é o id). Ignora data_inicio/data_fim", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome do cliente (busca parcial; também razão social e nome social). Orçamento sem cliente cadastrado não entra", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — uma situação (ids em /situacoes_orcamentos) — ids em `/situacoes_orcamentos`", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — um vendedor", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "string — orçamentos com um produto cujo nome tem palavra começando por este texto. Sem tipo, só procura nos orçamentos de produto", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "string — orçamentos com um serviço cujo nome tem palavra começando por este texto. Sem tipo, só procura nos orçamentos de produto: para orçamento de serviço mande tipo=servico", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados (modificado_em) a partir deste dia", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados até este dia; sem hora corta em 00:00 e deixa o próprio dia de fora: para incluí-lo mande AAAA-MM-DD 23:59:59", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": "integer" }, "url_anterior": { "type": "string" }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "object", "properties": [] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": [ "string", "null" ] } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": [ "string", "null" ] }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 22, "total_da_pagina": 2, "pagina_atual": 2, "limite_por_pagina": 20, "pagina_anterior": 1, "url_anterior": "/api/orcamentos?pagina=1", "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "497", "codigo": "57", "cliente_id": "6", "nome_cliente": "Jarvis Stark", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": "", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "539408", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "3", "intervalo_dias": "30", "hash": "GAbaqwexcAW", "equipamentos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "20.00", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": "4878064", "nome_plano_conta": "Plano Padrão 01", "observacao": null } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "20.00", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": "4878064", "nome_plano_conta": "Plano Padrão 01", "observacao": null } }, { "pagamento": { "data_vencimento": "2020-03-27", "valor": "20.00", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": "4878064", "nome_plano_conta": "Plano Padrão 01", "observacao": null } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "0", "possui_variacao": "0", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.00", "valor_venda": "5.50", "tipo_desconto": "R$", "desconto_valor": null, "desconto_porcentagem": null, "valor_total": "5.50" } }, { "produto": { "produto_id": 1238788, "variacao_id": 4152213, "nome_produto": "Teste 02", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "0", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "0.00", "valor_venda": "54.50", "tipo_desconto": "R$", "desconto_valor": null, "desconto_porcentagem": null, "valor_total": "54.50" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data do orçamento", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Lista orçamento a orçamento: data é só uma página e meta.total_registros é quantos bateram. Quantidade e valor do período: use relatorio_orcamentos, já somado — nunca some esta lista. Orçamento é proposta: nunca some com venda nem chame de faturado. Qual situação quer dizer aprovado varia por empresa: veja /situacoes_orcamentos e responda por nome_situacao. Os N maiores: ordenacao=valor_total&direcao=desc&limite=N com o período; sem ordenacao a ordem é por mês e não pelo dia nem pelo valor. Sem data_inicio/data_fim vem o histórico inteiro: mande o período pedido e diga qual usou. codigo é o número que o usuário fala e ignora as datas; id é outro número, o do caminho /orcamentos/{id}. Sem loja_id vem só a loja padrão da chave. Sem a permissão de ver orçamentos de outros usuários, só vêm os do usuário da chave. Filtro fora desta lista é ignorado sem aviso. Nada encontrado volta 200 com data [] e message \"Não há dados!\" — é zero resultado, não erro.", "description": "Sem filtro, a lista segue a tela e esconde os orçamentos em situação marcada para não aparecer na listagem. Com `codigo` ou `cliente_id` eles aparecem. Os itens vêm em cada orçamento e no detalhe. `ordenacao` aceita as colunas data, valor_total, codigo, cadastrado_em e modificado_em (com `direcao` asc ou desc); nome de campo da resposta que não é coluna dá erro 500. Sem `ordenacao`, a ordem é mês mais recente primeiro e, no mês, o cadastro mais novo.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do orçamento. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Cadastrar orçamentos", "operationId": "pedidos_orcamentos_cadastrar", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": "string" }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "object", "properties": [] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "513", "codigo": "58", "cliente_id": "7", "nome_cliente": "Tiago flheflj", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": "", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": "30 dias", "introducao": null, "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "0", "situacao_estoque": "0", "forma_pagamento_id": "539408", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "GAbaqwexcAW", "equipamentos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": "4878064", "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": "4878064", "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "0", "possui_variacao": "0", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.00", "valor_venda": "5.50", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "5.50" } }, { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Teste 02", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "0", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "0.00", "valor_venda": "54.50", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "54.50" } } ], "servicos": [ { "servico": { "id": "354", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "60.0000", "tipo_desconto": "R$", "desconto_valor": "0.0000", "desconto_porcentagem": "0.0000", "valor_total": "60.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo`, `codigo`, `cliente_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "integer" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "integer" }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "integer" }, "nome_centro_custo": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": "string" }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_frete": { "type": "integer" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "exibir_pagamento": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "integer" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" }, "pedido_id": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } } } }, "example": { "cliente_id": 7, "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": 0, "nome_transportadora": "", "centro_custo_id": 1, "nome_centro_custo": "Centro de Custo 01", "transportadora_id": null, "aos_cuidados_de": null, "validade": "30 dias", "introducao": null, "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "nome_canal_venda": "Presencial", "nome_loja": "Savassi", "valor_frete": 0, "desconto_valor": "", "desconto_porcentagem": "0", "exibir_pagamento": "0", "condicao_pagamento": "parcelado", "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": 4878064, "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "pedido_id": "8574616" } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": 4878064, "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "pedido_id": "8574616" } } ], "produtos": [ { "produto": { "id": "28272998", "nome_produto": "Teste 01", "variacao_id": "1246454", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": "UND", "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": "5.50", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0" } }, { "produto": { "id": "5423530", "nome_produto": "Teste 02", "variacao_id": null, "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": "UND", "quantidade": "1", "tipo_valor_id": 90858, "nome_tipo_valor": "Atacado", "valor_custo": 42.5, "valor_venda": 54.5, "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "0" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 60, "tipo_desconto": "R$", "desconto_valor": "0", "desconto_porcentagem": "0" } } ] } } } } } }, "/orcamentos/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar orçamentos", "operationId": "pedidos_orcamentos_visualizar", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": "string" }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "object", "properties": [] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "anexos": { "type": "array", "items": { "type": "object", "properties": { "anexo": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "513", "codigo": "58", "cliente_id": "7", "nome_cliente": "Tiago flheflj", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": "", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": "30 dias", "introducao": null, "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "539408", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "GAbaqwexcAW", "equipamentos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": "4878064", "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": "4878064", "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "0", "possui_variacao": "0", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.00", "valor_venda": "5.50", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "5.50" } }, { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Teste 02", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "0", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "0.00", "valor_venda": "54.50", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "54.50" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ], "anexos": [ { "anexo": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "{id} é o id do orçamento (campo id da listagem), não o codigo: com o número, liste antes com codigo=. Abre orçamento de produto e de serviço; id de venda ou de O.S. volta 404 dizendo o recurso certo. Itens em produtos e servicos, parcelas em pagamentos, campos extras em atributos.", "description": "Traz `anexos`, cada um com a `url` do arquivo. Anexo é enviado por `POST /api/orcamentos/{id}/anexos`; `anexos` no corpo do cadastro ou da edição é ignorado.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Editar orçamentos", "operationId": "pedidos_orcamentos_editar", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "data": { "type": "string" }, "previsao_entrega": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": "string" }, "validade": { "type": "string" }, "introducao": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "pedido_id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "521478", "codigo": "98565574", "cliente_id": "1156997", "vendedor_id": "45", "nome_vendedor": "Marcos Vinicius Otávio Barros", "data": "2020-01-27", "previsao_entrega": "2018-10-16", "situacao_id": "294341", "nome_situacao": "Em aberto", "valor_total": "69.90", "transportadora_id": "58457", "nome_transportadora": "Rapidex", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": "Nelson", "validade": "30 dias", "introducao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": "5.00", "nome_canal_venda": "Presencial", "nome_loja": "Matriz", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "539408", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "GAbaqwexcAW", "pagamentos": [ { "pagamento": { "pedido_id": "2156448", "data_vencimento": "2020-01-27", "valor": "25", "forma_pagamento_id": "200754", "nome_forma_pagamento": "Boleto bradesco", "plano_contas_id": "2541", "nome_plano_conta": "Administração", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "pedido_id": "2156448", "data_vencimento": "2020-01-27", "valor": "35.96", "forma_pagamento_id": "200754", "nome_forma_pagamento": "Boleto bradesco", "plano_contas_id": "2541", "nome_plano_conta": "Administração", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "id": "3035767", "produto_id": "2141430", "nome_produto": "Celular 10A", "variacao_id": "1246454", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": "UND", "quantidade": "1", "tipo_valor_id": "37998", "nome_tipo_valor": "Atacado", "valor_custo": "250.62", "valor_venda": "500", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "550.30" } } ], "servicos": [ { "servico": { "id": "358", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "60.0000", "tipo_desconto": "R$", "desconto_valor": "0.0000", "desconto_porcentagem": "0.0000", "valor_total": "60.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo`, `codigo`, `cliente_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "integer" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "integer" }, "nome_transportadora": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": "string" }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_frete": { "type": "integer" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "integer" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" }, "pedido_id": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "number" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } } } }, "example": { "cliente_id": 7, "nome_cliente": "Tiago flheflj", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": 0, "nome_transportadora": "", "transportadora_id": null, "aos_cuidados_de": null, "validade": "30 dias", "introducao": null, "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "nome_canal_venda": "Presencial", "nome_loja": "Savassi", "valor_frete": 0, "desconto_valor": "", "desconto_porcentagem": "0", "condicao_pagamento": "parcelado", "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": 4878064, "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "pedido_id": "8574616" } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35", "forma_pagamento_id": "539408", "nome_forma_pagamento": "BCash", "plano_contas_id": 4878064, "nome_plano_conta": "Ruga API - Sem Rota NEW2", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "pedido_id": "8574616" } } ], "produtos": [ { "produto": { "id": "28272998", "nome_produto": "Celular 10A", "variacao_id": "1246454", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 5.5, "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00" } }, { "produto": { "id": "5423530", "tipo": "S", "nome_produto": "teste", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 54.5, "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "0" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 60, "tipo_desconto": "R$", "desconto_valor": "0", "desconto_porcentagem": "0" } } ] } } } } }, "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Deletar orçamentos", "operationId": "pedidos_orcamentos_deletar", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Orçamento excluido com sucesso" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/orcamentos/gerar_parcelas": { "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Gerar parcelas orçamentos", "operationId": "pedidos_orcamentos_gerar_parcelas", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "gerar_parcelas", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "number" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "data_vencimento": "2020-01-27", "valor": 33.3299999999999982946974341757595539093017578125, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" }, { "data_vencimento": "2020-02-27", "valor": 33.3299999999999982946974341757595539093017578125, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" }, { "data_vencimento": "2020-03-27", "valor": 33.340000000000003410605131648480892181396484375, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `valor_total`, `forma_pagamento_id`, `numero_parcelas`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "valor_total": { "type": "integer" }, "forma_pagamento_id": { "type": "integer" }, "intervalo_dias": { "type": "integer" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "integer" } } }, "example": { "valor_total": 100, "forma_pagamento_id": 579722, "intervalo_dias": 30, "data_primeira_parcela": "2019-12-10", "numero_parcelas": 3 } } } } } }, "/orcamentos/{id}/anexos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar os anexos de orçamentos", "operationId": "pedidos_orcamentos_listar_anexos", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "listar_anexos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" }, { "id": "1521", "nome": "Contrato assinado", "arquivo": "9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Anexos do pedido na ordem de envio, cada um com a `url` do arquivo. Exige a permissão de visualizar do tipo do pedido. Pedido de outra empresa, ou que não é de orçamentos, é 404.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Anexar arquivo a orçamentos", "operationId": "pedidos_orcamentos_anexar", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "anexar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 201, "status": "success", "data": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } }, "400": { "description": "Sem o campo `arquivo`, mais de um arquivo na requisição ou arquivo vazio" }, "413": { "description": "Arquivo acima do tamanho máximo" }, "415": { "description": "Formato não aceito" }, "422": { "description": "O pedido já tem 10 anexos" } }, "description": "Envio em `multipart/form-data` (não JSON), um arquivo por requisição: `arquivo` e, opcional, `nome`. Regras do sistema: até 5 MB (5.242.880 bytes) por arquivo; formatos jpg, jpeg, png, gif, bmp, tiff, pdf, doc, docx, xls, xlsx, csv, txt, html, htm, xml, ofx, pfx, zip, rar; até 10 anexos por pedido. Arquivo maior é 413, formato fora da lista é 415 e o 11º anexo é 422. Pedido de outra empresa, ou que não é de orçamentos, é 404. Exige a permissão de editar do tipo do pedido; não depende da situação.\n\nExemplo: `curl -X POST https:///api/orcamentos/123/anexos -H 'access-token: …' -H 'secret-access-token: …' -F 'arquivo=@comprovante.pdf' -F 'nome=Comprovante'`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "arquivo": { "type": "string", "format": "binary", "description": "O arquivo. Um por requisição." }, "nome": { "type": "string", "description": "Nome exibido (até 100 caracteres). Sem ele, fica o nome do arquivo." } }, "required": [ "arquivo" ] } } } } } }, "/orcamentos/{id}/anexos/{anexo_id}": { "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Excluir um anexo de orçamentos", "operationId": "pedidos_orcamentos_deletar_anexo", "x-modulo": "pedidos", "x-recurso": "orcamentos", "x-operacao": "deletar_anexo", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } }, { "name": "anexo_id", "in": "path", "required": true, "description": "Identificador do anexo", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Apaga o anexo e o arquivo. Anexo que não é deste pedido é 404. Exige a permissão de editar do tipo do pedido.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_orcamentos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar situações de orçamentos", "operationId": "pedidos_situacoes_orcamentos_listar", "x-modulo": "pedidos", "x-recurso": "situacoes_orcamentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome da situação", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Situações dos orçamentos (produto e serviço), para situacao_id de /orcamentos e de relatorio_orcamentos. Qual delas quer dizer aprovado é decisão da empresa: não chute pelo nome. Situações são cadastradas por cada empresa: o id muda de uma empresa para outra e o nome é o que o usuário vê — responda pelo nome e use o id em situacao_id. Vêm na ordem da tela; padrao 1 marca a situação padrão (uma só). A lista não diz quais situações a empresa escondeu da listagem. Nada encontrado volta 200 com data [] e message \"Não há dados!\".", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_orcamentos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar campos extras de orçamentos", "operationId": "pedidos_atributos_orcamentos_listar", "x-modulo": "pedidos", "x-recurso": "atributos_orcamentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome do campo extra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Registro", "tipo": "numeros", "exibir_impressao": "Sim", "modificado_em": "2025-01-21 00:58:11", "cadastrado_em": "2025-01-21 00:58:11" }, { "id": "2", "nome": "Campo Aux", "tipo": "texto_simples", "exibir_impressao": "Não", "modificado_em": "2025-01-21 00:58:36", "cadastrado_em": "2025-01-21 00:58:36" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Campos extras que a empresa criou para os orçamentos (vendas, orçamentos e O.S. têm cada um os seus). No pedido de /orcamentos o valor vem em atributos, com atributo_id = o id daqui. Nenhum cadastrado volta 200 com data [] e message \"Nenhum campo extra foi encontrado!\": a empresa não usa campos extras ali, não é erro.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Cadastrar campos extras de orçamentos", "operationId": "pedidos_atributos_orcamentos_cadastrar", "x-modulo": "pedidos", "x-recurso": "atributos_orcamentos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Comprovante", "tipo": "check_list", "exibir_impressao": "Sim", "permitir_excluir": "1", "usuario_id": "131036", "nome_usuario": "Controle 1", "cadastrado_em": "2025-04-14 17:47:04", "modificado_em": "2025-04-14 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "PIX" }, { "id": "2", "atributo_id": "5", "nome": "Boleto" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Comprovante", "tipo": "check_list", "exibir_impressao": "Sim", "opcoes": [ { "nome": "PIX" }, { "nome": "Boleto" } ] } } } } } }, "/atributos_orcamentos/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar campos extras de orçamentos", "operationId": "pedidos_atributos_orcamentos_visualizar", "x-modulo": "pedidos", "x-recurso": "atributos_orcamentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documentos", "tipo": "check_list", "exibir_impressao": "Não", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "CPF" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Editar campos extras de orçamentos", "operationId": "pedidos_atributos_orcamentos_editar", "x-modulo": "pedidos", "x-recurso": "atributos_orcamentos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documentos", "tipo": "check_list", "exibir_impressao": "Não", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "RH" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Deletar campos extras de orçamentos", "operationId": "pedidos_atributos_orcamentos_deletar", "x-modulo": "pedidos", "x-recurso": "atributos_orcamentos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Campo extra removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/vendas": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar vendas", "operationId": "pedidos_vendas_listar", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja (ids em /lojas); sem ele vem só a loja padrão da chave (a matriz, ou a primeira loja que o usuário acessa), não todas", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "produto = só venda de produto, servico = só venda de serviço, vendas_balcao = só balcão (PDV); sem ele vêm produto e serviço juntos, sem o balcão", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número da venda (o que aparece na tela; não é o id). Ignora data_inicio/data_fim", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome do cliente (busca parcial; também razão social e nome social). Venda sem cliente cadastrado não entra", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — uma situação (ids em /situacoes_vendas) — ids em `/situacoes_vendas`", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — um vendedor", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "string — vendas com um produto cujo nome tem palavra começando por este texto (ex.: coca). Sem tipo, só procura nas vendas de produto", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "string — vendas com um serviço cujo nome tem palavra começando por este texto. Sem tipo, só procura nas vendas de produto: para venda de serviço mande tipo=servico", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados (modificado_em) a partir deste dia", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados até este dia; sem hora corta em 00:00 e deixa o próprio dia de fora: para incluí-lo mande AAAA-MM-DD 23:59:59", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": [ "string", "null" ] }, "observacoes_interna": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "object", "properties": [] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": [ "string", "null" ] }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": [ "string", "null" ] }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_da_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "505", "codigo": "795", "cliente_id": "1", "nome_cliente": "Ronei Marcos Silva Marques", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": null, "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": null, "observacoes_interna": null, "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "579722", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": null, "detalhes": "Lorem Ipsum is simply dummy text of the", "movimenta_estoque": "0", "possui_variacao": "0", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.00", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": null, "desconto_porcentagem": null, "valor_total": "60.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data da venda", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Lista venda a venda: data é só uma página e meta.total_registros é quantas vendas bateram. Quanto vendeu, total, ticket ou ranking por produto, cliente ou vendedor: use relatorio_vendas e os outros relatórios, já somados — nunca some esta lista; e não compare o total desta lista com relatorio_vendas sem tipo, que conta também balcão e O.S. As N maiores vendas: ordenacao=valor_total&direcao=desc&limite=N com o período; sem ordenacao a ordem é por mês e não pelo dia nem pelo valor. Sem data_inicio/data_fim vem o histórico inteiro: mande o período pedido e diga qual usou. codigo é o número que o usuário fala (\"venda 105\") e ignora as datas; id é outro número, o do caminho /vendas/{id}. Responda a situação por nome_situacao. Sem loja_id vem só a loja padrão da chave: para as outras lojas repita com loja_id. Sem a permissão de ver vendas de outros usuários, só vêm as do usuário da chave. Filtro fora desta lista é ignorado sem aviso (canal_venda_id, produto_id e transportadora_id voltam todas as vendas): para canal ou produto use relatorio_vendas. Nada encontrado volta 200 com data [] e message \"Não há dados!\" — é zero resultado, não erro. A previsão de entrega vem em prazo_entrega.", "description": "Sem filtro, a lista segue a tela e esconde os pedidos em situação marcada para não aparecer na listagem. Com `codigo` ou `cliente_id` eles aparecem (o total pode ser maior que o da lista sem filtro). Os itens vêm em cada venda e no detalhe: `produtos` e `servicos`, cada chave só quando a venda tem item daquele tipo. Sem `tipo` vêm as vendas de produto e de serviço; as de balcão (PDV) só com `tipo=vendas_balcao`. Sem data_inicio/data_fim vem o histórico inteiro (não há recorte de mês). `ordenacao` aceita as colunas data, valor_total, codigo, cadastrado_em e modificado_em (com `direcao` asc ou desc); nome de campo da resposta que não é coluna dá erro 500. Sem `ordenacao`, a ordem é mês mais recente primeiro e, no mês, o cadastro mais novo.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Cadastrar vendas", "operationId": "pedidos_vendas_cadastrar", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": [ "string", "null" ] }, "observacoes_interna": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "object", "properties": [] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "515", "codigo": "797", "cliente_id": "1", "nome_cliente": "Ronei Marcos Silva Marques", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": null, "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": null, "observacoes_interna": null, "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "0", "situacao_estoque": "0", "forma_pagamento_id": "640517", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "700.62", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "60.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo`, `codigo`, `cliente_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "vendedor_id": { "type": "string" }, "data": { "type": "string" }, "prazo_entrega": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "transportadora_id": { "type": "string" }, "centro_custo_id": { "type": "string" }, "valor_frete": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } } } }, "example": { "tipo": "produto", "cliente_id": "1", "vendedor_id": "45", "data": "2020-01-27", "prazo_entrega": "2019-12-06", "situacao_id": "3150", "nome_situacao": "Confirmado", "transportadora_id": "", "centro_custo_id": "1", "valor_frete": "0.00", "condicao_pagamento": "parcelado", "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": "22", "variacao_id": "1246454", "detalhes": "Lorem Ipsum is simply dummy text of the", "quantidade": "1", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 60, "tipo_desconto": "R$", "desconto_valor": "0", "desconto_porcentagem": "0" } } ] } } } } } }, "/vendas/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar vendas", "operationId": "pedidos_vendas_visualizar", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": [ "string", "null" ] }, "observacoes_interna": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "object", "properties": [] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "anexos": { "type": "array", "items": { "type": "object", "properties": { "anexo": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "515", "codigo": "797", "cliente_id": "1", "nome_cliente": "Ronei Marcos Silva Marques", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": null, "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": null, "observacoes_interna": null, "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "640517", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "700.62", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "60.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ], "anexos": [ { "anexo": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "{id} é o id da venda (campo id da listagem), não o codigo: com o número, liste antes com codigo=. Abre venda de produto, de serviço e de balcão (PDV). id de orçamento ou de O.S. volta 404 dizendo o recurso certo (/orcamentos/{id} ou /ordens_servicos/{id}). Itens em produtos e servicos, parcelas em pagamentos, campos extras em atributos.", "description": "Traz `anexos`, cada um com a `url` do arquivo. Anexo é enviado por `POST /api/vendas/{id}/anexos`; `anexos` no corpo do cadastro ou da edição é ignorado.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Editar vendas", "operationId": "pedidos_vendas_editar", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": [ "string", "null" ] }, "observacoes_interna": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "object", "properties": [] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "515", "codigo": "797", "cliente_id": "1", "nome_cliente": "Ronei Marcos Silva Marques", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": "5", "nome_transportadora": "Rapid Transportadora LTDA", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": null, "observacoes_interna": null, "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "640517", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "700.62", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "60.00" } } ], "servicos": [ { "servico": { "id": "354", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "60.0000", "tipo_desconto": "R$", "desconto_valor": "0.0000", "desconto_porcentagem": "0.0000", "valor_total": "60.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo`, `codigo`, `cliente_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "vendedor_id": { "type": "string" }, "data": { "type": "string" }, "prazo_entrega": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "transportadora_id": { "type": "string" }, "centro_custo_id": { "type": "string" }, "valor_frete": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } } } }, "example": { "tipo": "produto", "cliente_id": "1", "vendedor_id": "45", "data": "2020-01-27", "prazo_entrega": "2020-01-06", "situacao_id": "3150", "nome_situacao": "Confirmado", "transportadora_id": "5", "centro_custo_id": "1", "valor_frete": "0.00", "condicao_pagamento": "parcelado", "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": "22", "variacao_id": "1246454", "detalhes": "Lorem Ipsum is simply dummy text of the", "quantidade": "1", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 60, "tipo_desconto": "R$", "desconto_valor": "0", "desconto_porcentagem": "0" } } ] } } } } }, "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Deletar vendas", "operationId": "pedidos_vendas_deletar", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Venda removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/vendas/gerar_parcelas": { "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Gerar parcelas vendas", "operationId": "pedidos_vendas_gerar_parcelas", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "gerar_parcelas", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "number" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "data_vencimento": "2019-12-10", "valor": 33.3299999999999982946974341757595539093017578125, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" }, { "data_vencimento": "2020-01-10", "valor": 33.3299999999999982946974341757595539093017578125, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" }, { "data_vencimento": "2020-02-10", "valor": 33.340000000000003410605131648480892181396484375, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `valor_total`, `forma_pagamento_id`, `numero_parcelas`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "valor_total": { "type": "integer" }, "forma_pagamento_id": { "type": "integer" }, "intervalo_dias": { "type": "integer" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "integer" } } }, "example": { "valor_total": 100, "forma_pagamento_id": 579722, "intervalo_dias": 30, "data_primeira_parcela": "2019-12-10", "numero_parcelas": 3 } } } } } }, "/vendas/{id}/anexos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar os anexos de vendas", "operationId": "pedidos_vendas_listar_anexos", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "listar_anexos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" }, { "id": "1521", "nome": "Contrato assinado", "arquivo": "9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Anexos do pedido na ordem de envio, cada um com a `url` do arquivo. Exige a permissão de visualizar do tipo do pedido. Pedido de outra empresa, ou que não é de vendas (produtos, serviços e balcão), é 404.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Anexar arquivo a vendas", "operationId": "pedidos_vendas_anexar", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "anexar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 201, "status": "success", "data": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } }, "400": { "description": "Sem o campo `arquivo`, mais de um arquivo na requisição ou arquivo vazio" }, "413": { "description": "Arquivo acima do tamanho máximo" }, "415": { "description": "Formato não aceito" }, "422": { "description": "O pedido já tem 10 anexos" } }, "description": "Envio em `multipart/form-data` (não JSON), um arquivo por requisição: `arquivo` e, opcional, `nome`. Regras do sistema: até 5 MB (5.242.880 bytes) por arquivo; formatos jpg, jpeg, png, gif, bmp, tiff, pdf, doc, docx, xls, xlsx, csv, txt, html, htm, xml, ofx, pfx, zip, rar; até 10 anexos por pedido. Arquivo maior é 413, formato fora da lista é 415 e o 11º anexo é 422. Pedido de outra empresa, ou que não é de vendas (produtos, serviços e balcão), é 404. Exige a permissão de editar do tipo do pedido; não depende da situação.\n\nExemplo: `curl -X POST https:///api/vendas/123/anexos -H 'access-token: …' -H 'secret-access-token: …' -F 'arquivo=@comprovante.pdf' -F 'nome=Comprovante'`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "arquivo": { "type": "string", "format": "binary", "description": "O arquivo. Um por requisição." }, "nome": { "type": "string", "description": "Nome exibido (até 100 caracteres). Sem ele, fica o nome do arquivo." } }, "required": [ "arquivo" ] } } } } } }, "/vendas/{id}/anexos/{anexo_id}": { "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Excluir um anexo de vendas", "operationId": "pedidos_vendas_deletar_anexo", "x-modulo": "pedidos", "x-recurso": "vendas", "x-operacao": "deletar_anexo", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } }, { "name": "anexo_id", "in": "path", "required": true, "description": "Identificador do anexo", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Apaga o anexo e o arquivo. Anexo que não é deste pedido é 404. Exige a permissão de editar do tipo do pedido.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_vendas": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar situações de vendas", "operationId": "pedidos_situacoes_vendas_listar", "x-modulo": "pedidos", "x-recurso": "situacoes_vendas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome da situação", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 4, "total_da_pagina": 4, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "17", "nome": "Em aberto", "padrao": "0" }, { "id": "12138", "nome": "Em andamento", "padrao": "0" }, { "id": "3150", "nome": "Confirmado", "padrao": "1" }, { "id": "12139", "nome": "Cancelado", "padrao": "0" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Situações das vendas (produto, serviço e balcão), para situacao_id de /vendas e dos relatórios de vendas. Situações são cadastradas por cada empresa: o id muda de uma empresa para outra e o nome é o que o usuário vê — responda pelo nome e use o id em situacao_id. Vêm na ordem da tela; padrao 1 marca a situação padrão (uma só). A lista não diz quais situações a empresa escondeu da listagem. Nada encontrado volta 200 com data [] e message \"Não há dados!\". lancar diz o que a situação lança ao entrar nela: 0 = nada, 1 = estoque e financeiro, 2 = só estoque, 3 = só financeiro. editar 0 = a venda nessa situação não pode ser editada. O.S. e orçamento têm situações próprias (outros ids).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_vendas": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar campos extras vendas", "operationId": "pedidos_atributos_vendas_listar", "x-modulo": "pedidos", "x-recurso": "atributos_vendas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome do campo extra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Registro", "tipo": "numeros", "exibir_impressao": "Sim", "modificado_em": "2025-01-21 00:58:11", "cadastrado_em": "2025-01-21 00:58:11" }, { "id": "2", "nome": "Campo Aux", "tipo": "texto_simples", "exibir_impressao": "Quando preenchido", "modificado_em": "2025-01-21 00:58:36", "cadastrado_em": "2025-01-21 00:58:36" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Campos extras que a empresa criou para as vendas (vendas, orçamentos e O.S. têm cada um os seus). No pedido de /vendas o valor vem em atributos, com atributo_id = o id daqui. Nenhum cadastrado volta 200 com data [] e message \"Nenhum campo extra foi encontrado!\": a empresa não usa campos extras ali, não é erro.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Cadastrar campos extras vendas", "operationId": "pedidos_atributos_vendas_cadastrar", "x-modulo": "pedidos", "x-recurso": "atributos_vendas", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Comprovante", "tipo": "check_list", "exibir_impressao": "Sim", "permitir_excluir": "1", "usuario_id": "131036", "nome_usuario": "Controle 1", "cadastrado_em": "2025-04-14 17:47:04", "modificado_em": "2025-04-14 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "PIX" }, { "id": "2", "atributo_id": "5", "nome": "Boleto" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Comprovante", "tipo": "check_list", "exibir_impressao": "Sim", "opcoes": [ { "nome": "PIX" }, { "nome": "Boleto" } ] } } } } } }, "/atributos_vendas/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar campos extras vendas", "operationId": "pedidos_atributos_vendas_visualizar", "x-modulo": "pedidos", "x-recurso": "atributos_vendas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documento", "tipo": "check_list", "exibir_impressao": "Não", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "CPF" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Editar campos extras vendas", "operationId": "pedidos_atributos_vendas_editar", "x-modulo": "pedidos", "x-recurso": "atributos_vendas", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documentos", "tipo": "check_list", "exibir_impressao": "Não", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "RG" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Deletar campos extras vendas", "operationId": "pedidos_atributos_vendas_deletar", "x-modulo": "pedidos", "x-recurso": "atributos_vendas", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Campo extra removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ordens_servicos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar ordens de serviços", "operationId": "pedidos_ordens_servicos_listar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S., o campo data_entrada)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja (ids em /lojas); sem ele vem só a loja padrão da chave (a matriz, ou a primeira loja que o usuário acessa), não todas", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número da O.S. (o que aparece na tela; não é o id). Ignora data_inicio/data_fim", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — nome do cliente (busca parcial; também razão social e nome social). O.S. sem cliente cadastrado não entra", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — uma situação (ids em /situacoes_ordens_servicos) — ids em `/situacoes_ordens_servicos`", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "tecnico_id", "in": "query", "required": false, "description": "int — técnico responsável ou participante da O.S.", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — um vendedor", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "data_inicio_e", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de saída prevista (o campo data_saida); filtra junto com data_inicio/data_fim se vierem", "schema": { "type": "string" } }, { "name": "data_fim_e", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de saída prevista", "schema": { "type": "string" } }, { "name": "sem_prazo", "in": "query", "required": false, "description": "1 = só as O.S. sem data de saída prevista", "schema": { "type": "string" } }, { "name": "equipamento", "in": "query", "required": false, "description": "string — O.S. com equipamento cujo nome tem palavra começando por este texto", "schema": { "type": "string" } }, { "name": "marca", "in": "query", "required": false, "description": "string — marca do equipamento (começo de palavra)", "schema": { "type": "string" } }, { "name": "modelo", "in": "query", "required": false, "description": "string — modelo do equipamento (começo de palavra)", "schema": { "type": "string" } }, { "name": "serie", "in": "query", "required": false, "description": "string — número de série do equipamento (começo de palavra)", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "string — O.S. com um produto cujo nome tem palavra começando por este texto", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "string — O.S. com um serviço cujo nome tem palavra começando por este texto", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados (modificado_em) a partir deste dia", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — alterados até este dia; sem hora corta em 00:00 e deixa o próprio dia de fora: para incluí-lo mande AAAA-MM-DD 23:59:59", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "array", "items": { "type": "object", "properties": { "equipamento": { "type": "object", "properties": { "equipamento": { "type": "string" }, "serie": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "condicoes": { "type": "string" }, "defeitos": { "type": "string" }, "acessorios": { "type": "string" }, "solucao": { "type": "string" }, "laudo": { "type": "string" }, "termos_garantia": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_da_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "522", "codigo": "1022", "cliente_id": "4", "nome_cliente": "Alícia Nicole Assunção", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-24", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": "", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "640517", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [ { "equipamento": { "equipamento": "Equipamento 01", "serie": "1", "marca": "Marca 01", "modelo": "Modelo 01", "condicoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "defeitos": "Phasellus convallis neque non lectus interdum, egestas dictum massa ullamcorper.", "acessorios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "solucao": "Praesent bibendum non ex at viverra.", "laudo": "Nulla rhoncus eget tellus sed dictum.", "termos_garantia": "Donec lorem dui, tempor id justo vel, gravida lacinia diam. Aliquam suscipit feugiat lacinia." } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "700.62", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "60.00" } } ] }, { "id": "520", "codigo": "1021", "cliente_id": "9", "nome_cliente": "Otávio Juan Benício da Rosa II", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": "45", "nome_tecnico": "João da Silva", "data": "2020-01-24", "previsao_entrega": "2020-01-30", "situacao_id": "20224", "nome_situacao": "Execução", "valor_total": "850.99", "transportadora_id": null, "nome_transportadora": null, "centro_custo_id": null, "nome_centro_custo": "", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": "texto1\r\ntexto 2", "observacoes_interna": "", "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "700.62", "condicao_pagamento": "a_vista", "situacao_financeiro": "1", "situacao_estoque": "1", "hash": "wpQseRt", "equipamentos": [ { "equipamento": { "equipamento": "Equipamento 01", "serie": "", "marca": "", "modelo": "", "condicoes": "texto2\r\ntexto 2", "defeitos": "", "acessorios": "", "solucao": "", "laudo": "", "termos_garantia": "1990\r\nValidade do orçamento será de 10 dias a contar da data de emissão desta Ordem de Serviço.\r\nPara todo aparelho será apresentado orçamento prévio e detalhado, e será executado mediante assinatura do cliente.\r\nOrçamento não autorizado incide a cobrança de taxa especifica a cima./09/Garantia de 90 dias, contados da data da execução do conserto, valido apenas para o defeito constatado por este posto e, abrange todas as pecas substituídas. \r\nExceto aquelas não cobertas pelo termo de garantia de fabrica. O aparelho foi devidamente lacrado e, sua violação implica em perda de garantia. Após 10 dias de pronto, o preço das pecas e serviços estará sujeitos a reajustes (tabela do dia).\r\nO aparelho devera ser retirado no prazo máximo de 90 dias, contados da data do termino do conserto. Após esse prazo será cobrada taxa de R$ 0,50 ao dia de armazenamento e/ou seguro ate o prazo de 06 meses, aparelhos cuja permanência, em nossa loja superem 180 dias serão desmontados ou sucateados independente da situação que se encontrem: Orçamento, Pronto, ou sem conserto. Lei 8.078 de 11" } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-24", "valor": "850.99", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de entrada da O.S.", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Lista O.S. a O.S.: data é só uma página e meta.total_registros é quantas bateram. Total, valor e quantidade do período: use relatorio_ordens_servicos; por situação, /ordens_servicos/kanban — nunca some esta lista. A data de entrada vem em data_entrada e a saída prevista em data_saida. O que está atrasado: data_fim_e=ontem traz a saída prevista vencida, inclusive de O.S. já finalizadas — filtre situacao_id (uma situação por vez) ou olhe nome_situacao; sem_prazo=1 traz as sem data de saída. Sem data_inicio/data_fim vem o histórico inteiro: mande o período pedido e diga qual usou. codigo é o número que o usuário fala (\"OS 5\") e ignora as datas; id é outro número, o do caminho /ordens_servicos/{id}. As N maiores: ordenacao=valor_total&direcao=desc&limite=N. Responda a situação por nome_situacao. Sem loja_id vem só a loja padrão da chave. Sem a permissão de ver O.S. de outros usuários, só vêm as que o usuário da chave cadastrou, vendeu ou atende como técnico. Filtro fora desta lista é ignorado sem aviso. Nada encontrado volta 200 com data [] e message \"Não há dados!\" — é zero resultado, não erro.", "description": "Sem filtro, a lista segue a tela e esconde as O.S. em situação marcada para não aparecer na listagem. Com `codigo` ou `cliente_id` elas aparecem. Os itens vêm em cada O.S. e no detalhe. `ordenacao` aceita as colunas data (entrada), previsao_entrega (saída prevista), valor_total, codigo, cadastrado_em e modificado_em (com `direcao` asc ou desc); data_entrada e data_saida são nomes da resposta e dão erro 500. Sem `ordenacao`, a ordem é mês de entrada mais recente primeiro e, no mês, o cadastro mais novo.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S.. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Cadastrar ordens de serviços", "operationId": "pedidos_ordens_servicos_cadastrar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "array", "items": { "type": "object", "properties": { "equipamento": { "type": "object", "properties": { "equipamento": { "type": "string" }, "serie": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "condicoes": { "type": "string" }, "defeitos": { "type": "string" }, "acessorios": { "type": "string" }, "solucao": { "type": "string" }, "laudo": { "type": "string" }, "termos_garantia": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "517", "codigo": "1018", "cliente_id": "4", "nome_cliente": "Alícia Nicole Assunção", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": null, "nome_transportadora": "", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": "0.00", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "640517", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [ { "equipamento": { "equipamento": "Equipamento 01", "serie": "1", "marca": "Marca 01", "modelo": "Modelo 01", "condicoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "defeitos": "Phasellus convallis neque non lectus interdum, egestas dictum massa ullamcorper.", "acessorios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "solucao": "Praesent bibendum non ex at viverra.", "laudo": "Nulla rhoncus eget tellus sed dictum.", "termos_garantia": "Donec lorem dui, tempor id justo vel, gravida lacinia diam. Aliquam suscipit feugiat lacinia." } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "700.62", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "60.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `codigo`, `cliente_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "data_entrada": { "type": "string" }, "data_saida": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "equipamentos": { "type": "array", "items": { "type": "object", "properties": { "equipamento": { "type": "object", "properties": { "equipamento": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "serie": { "type": "string" }, "condicoes": { "type": "string" }, "defeitos": { "type": "string" }, "acessorios": { "type": "string" }, "solucao": { "type": "string" }, "laudo": { "type": "string" }, "termos_garantia": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "categoria_id": { "type": "string" }, "nome_categoria": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } } } }, "example": { "cliente_id": "4", "vendedor_id": "45", "nome_vendedor": "João da Silva", "data_entrada": "2020-01-24", "data_saida": "2020-01-27", "situacao_id": "3150", "nome_situacao": "Confirmado", "transportadora_id": "", "nome_transportadora": "", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "observacoes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": "0.00", "condicao_pagamento": "parcelado", "equipamentos": [ { "equipamento": { "equipamento": "Equipamento 01", "marca": "Marca 01", "modelo": "Modelo 01", "serie": "1", "condicoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "defeitos": "Phasellus convallis neque non lectus interdum, egestas dictum massa ullamcorper.", "acessorios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "solucao": "Praesent bibendum non ex at viverra. ", "laudo": "Nulla rhoncus eget tellus sed dictum. ", "termos_garantia": "Donec lorem dui, tempor id justo vel, gravida lacinia diam. Aliquam suscipit feugiat lacinia." } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "categoria_id": "2514", "nome_categoria": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "categoria_id": "2514", "nome_categoria": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": "22", "variacao_id": "1246454", "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "quantidade": "1", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 60, "tipo_desconto": "R$", "desconto_valor": "0", "desconto_porcentagem": "0" } } ] } } } } } }, "/ordens_servicos/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar ordens de serviços", "operationId": "pedidos_ordens_servicos_visualizar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "array", "items": { "type": "object", "properties": { "equipamento": { "type": "object", "properties": { "equipamento": { "type": "string" }, "serie": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "condicoes": { "type": "string" }, "defeitos": { "type": "string" }, "acessorios": { "type": "string" }, "solucao": { "type": "string" }, "laudo": { "type": "string" }, "termos_garantia": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "anexos": { "type": "array", "items": { "type": "object", "properties": { "anexo": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "519", "codigo": "1020", "cliente_id": "4", "nome_cliente": "Alícia Nicole Assunção", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": "5", "nome_transportadora": "Rapid Transportadora LTDA", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": "Integer massa erat, aliquet quis neque et, pretium ornare diam. .", "observacoes_interna": "llentesque eu lacinia dolor. Aliquam erat volutpat.", "valor_frete": "9.80", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "640517", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [ { "equipamento": { "equipamento": "Equipamento 01", "serie": "1", "marca": "Marca 01", "modelo": "Modelo 01", "condicoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "defeitos": "Phasellus convallis neque non lectus interdum, egestas dictum massa ullamcorper.", "acessorios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "solucao": "Praesent bibendum non ex at viverra.", "laudo": "Nulla rhoncus eget tellus sed dictum.", "termos_garantia": "Donec lorem dui, tempor id justo vel, gravida lacinia diam. Aliquam suscipit feugiat lacinia." } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "700.62", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "60.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "25.0000", "tipo_desconto": "%", "desconto_valor": null, "desconto_porcentagem": "5.0000", "valor_total": "23.75" } } ], "anexos": [ { "anexo": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "{id} é o id da O.S. (campo id da listagem), não o codigo: com o número, liste antes com codigo=. id de venda ou de orçamento volta 404 dizendo o recurso certo. Equipamentos em equipamentos, itens em produtos e servicos, parcelas em pagamentos, campos extras em atributos; entrada em data_entrada e saída prevista em data_saida.", "description": "Traz `anexos`, cada um com a `url` do arquivo. Anexo é enviado por `POST /api/ordens_servicos/{id}/anexos`; `anexos` no corpo do cadastro ou da edição é ignorado.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Editar ordens de serviços", "operationId": "pedidos_ordens_servicos_editar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "nome_tecnico": { "type": [ "string", "null" ] }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "aos_cuidados_de": { "type": [ "string", "null" ] }, "validade": { "type": [ "string", "null" ] }, "introducao": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_custo": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "string" }, "intervalo_dias": { "type": "string" }, "hash": { "type": "string" }, "equipamentos": { "type": "array", "items": { "type": "object", "properties": { "equipamento": { "type": "object", "properties": { "equipamento": { "type": "string" }, "serie": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "condicoes": { "type": "string" }, "defeitos": { "type": "string" }, "acessorios": { "type": "string" }, "solucao": { "type": "string" }, "laudo": { "type": "string" }, "termos_garantia": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_custo": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "519", "codigo": "1020", "cliente_id": "4", "nome_cliente": "Alícia Nicole Assunção", "vendedor_id": "45", "nome_vendedor": "João da Silva", "tecnico_id": null, "nome_tecnico": null, "data": "2020-01-27", "previsao_entrega": null, "situacao_id": "3150", "nome_situacao": "Confirmado", "valor_total": "60.00", "transportadora_id": "5", "nome_transportadora": "Rapid Transportadora LTDA", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "aos_cuidados_de": null, "validade": null, "introducao": null, "observacoes": "Integer massa erat, aliquet quis neque et, pretium ornare diam. .", "observacoes_interna": "llentesque eu lacinia dolor. Aliquam erat volutpat.", "valor_frete": "9.80", "nome_canal_venda": "Kautrite III", "nome_loja": "Savassi", "valor_custo": "0.00", "condicao_pagamento": "parcelado", "situacao_financeiro": "1", "situacao_estoque": "1", "forma_pagamento_id": "640517", "data_primeira_parcela": "2020-01-27", "numero_parcelas": "2", "intervalo_dias": "30", "hash": "wpQseRf", "equipamentos": [ { "equipamento": { "equipamento": "Equipamento 01", "serie": "1", "marca": "Marca 01", "modelo": "Modelo 01", "condicoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "defeitos": "Phasellus convallis neque non lectus interdum, egestas dictum massa ullamcorper.", "acessorios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "solucao": "Praesent bibendum non ex at viverra.", "laudo": "Nulla rhoncus eget tellus sed dictum.", "termos_garantia": "Donec lorem dui, tempor id justo vel, gravida lacinia diam. Aliquam suscipit feugiat lacinia." } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35.00", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": "2514", "nome_plano_conta": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": 1238787, "variacao_id": 4152212, "nome_produto": "Televisão Smart TV - Plasma 52 P", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "UND", "quantidade": "1.00", "tipo_valor_id": "90858", "nome_tipo_valor": "Atacado", "valor_custo": "700.62", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "60.00" } } ], "servicos": [ { "servico": { "id": "354", "servico_id": "437", "nome_servico": "Serviço 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1.00", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_custo": "0.0000", "valor_venda": "60.0000", "tipo_desconto": "R$", "desconto_valor": "0.0000", "desconto_porcentagem": "0.0000", "valor_total": "60.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `tipo`, `codigo`, `cliente_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "data": { "type": "string" }, "saida": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "equipamentos": { "type": "array", "items": { "type": "object", "properties": { "equipamento": { "type": "object", "properties": { "equipamento": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "serie": { "type": "string" }, "condicoes": { "type": "string" }, "defeitos": { "type": "string" }, "acessorios": { "type": "string" }, "solucao": { "type": "string" }, "laudo": { "type": "string" }, "termos_garantia": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "categoria_id": { "type": "string" }, "nome_categoria": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "sigla_unidade": { "type": [ "string", "null" ] }, "quantidade": { "type": "string" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "nome_tipo_valor": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" } } } } } } } }, "example": { "cliente_id": "4", "vendedor_id": "45", "nome_vendedor": "João da Silva", "data": "2020-01-27", "saida": "2020-01-27", "situacao_id": "3150", "nome_situacao": "Confirmado", "transportadora_id": "", "nome_transportadora": "5", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "observacoes": "Integer massa erat, aliquet quis neque et, pretium ornare diam. .", "observacoes_interna": "llentesque eu lacinia dolor. Aliquam erat volutpat.", "valor_frete": "9.80", "condicao_pagamento": "parcelado", "equipamentos": [ { "equipamento": { "equipamento": "Equipamento 01", "marca": "Marca 01", "modelo": "Modelo 01", "serie": "1", "condicoes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "defeitos": "Phasellus convallis neque non lectus interdum, egestas dictum massa ullamcorper.", "acessorios": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", "solucao": "Praesent bibendum non ex at viverra. ", "laudo": "Nulla rhoncus eget tellus sed dictum. ", "termos_garantia": "Donec lorem dui, tempor id justo vel, gravida lacinia diam. Aliquam suscipit feugiat lacinia." } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "25", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "categoria_id": "2514", "nome_categoria": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "35", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista ", "categoria_id": "2514", "nome_categoria": "Prestações de serviçosAC", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "produto_id": "22", "nome_produto": "Televisão Smart TV - Plasma 52 P", "variacao_id": "1246454", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "quantidade": "1", "valor_venda": "60.00", "tipo_desconto": "R$", "desconto_valor": "0.00", "desconto_porcentagem": "0.00" } } ], "servicos": [ { "servico": { "id": "351", "servico_id": "437", "nome_servico": "Teste 01", "detalhes": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "sigla_unidade": null, "quantidade": "1", "tipo_valor_id": null, "nome_tipo_valor": null, "valor_venda": 60, "tipo_desconto": "R$", "desconto_valor": "0", "desconto_porcentagem": "0" } } ] } } } } }, "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Deletar ordens de serviços", "operationId": "pedidos_ordens_servicos_deletar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Ordem de serviço excluído com sucesso" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ordens_servicos/gerar_parcelas": { "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Gerar parcelas ordens de serviços", "operationId": "pedidos_ordens_servicos_gerar_parcelas", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "gerar_parcelas", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "number" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "data_vencimento": "2019-12-10", "valor": 33.3299999999999982946974341757595539093017578125, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" }, { "data_vencimento": "2020-01-10", "valor": 33.3299999999999982946974341757595539093017578125, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" }, { "data_vencimento": "2020-02-10", "valor": 33.340000000000003410605131648480892181396484375, "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `valor_total`, `forma_pagamento_id`, `numero_parcelas`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "valor_total": { "type": "integer" }, "forma_pagamento_id": { "type": "integer" }, "intervalo_dias": { "type": "integer" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "integer" } } }, "example": { "valor_total": 100, "forma_pagamento_id": 579722, "intervalo_dias": 30, "data_primeira_parcela": "2019-12-10", "numero_parcelas": 3 } } } } } }, "/ordens_servicos/{id}/anexos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar os anexos de ordens de serviços", "operationId": "pedidos_ordens_servicos_listar_anexos", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "listar_anexos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" }, { "id": "1521", "nome": "Contrato assinado", "arquivo": "9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Anexos do pedido na ordem de envio, cada um com a `url` do arquivo. Exige a permissão de visualizar do tipo do pedido. Pedido de outra empresa, ou que não é de ordens de serviço, é 404.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Anexar arquivo a ordens de serviços", "operationId": "pedidos_ordens_servicos_anexar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "anexar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 201, "status": "success", "data": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } }, "400": { "description": "Sem o campo `arquivo`, mais de um arquivo na requisição ou arquivo vazio" }, "413": { "description": "Arquivo acima do tamanho máximo" }, "415": { "description": "Formato não aceito" }, "422": { "description": "O pedido já tem 10 anexos" } }, "description": "Envio em `multipart/form-data` (não JSON), um arquivo por requisição: `arquivo` e, opcional, `nome`. Regras do sistema: até 5 MB (5.242.880 bytes) por arquivo; formatos jpg, jpeg, png, gif, bmp, tiff, pdf, doc, docx, xls, xlsx, csv, txt, html, htm, xml, ofx, pfx, zip, rar; até 10 anexos por pedido. Arquivo maior é 413, formato fora da lista é 415 e o 11º anexo é 422. Pedido de outra empresa, ou que não é de ordens de serviço, é 404. Exige a permissão de editar do tipo do pedido; não depende da situação.\n\nExemplo: `curl -X POST https:///api/ordens_servicos/123/anexos -H 'access-token: …' -H 'secret-access-token: …' -F 'arquivo=@comprovante.pdf' -F 'nome=Comprovante'`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "arquivo": { "type": "string", "format": "binary", "description": "O arquivo. Um por requisição." }, "nome": { "type": "string", "description": "Nome exibido (até 100 caracteres). Sem ele, fica o nome do arquivo." } }, "required": [ "arquivo" ] } } } } } }, "/ordens_servicos/{id}/anexos/{anexo_id}": { "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Excluir um anexo de ordens de serviços", "operationId": "pedidos_ordens_servicos_deletar_anexo", "x-modulo": "pedidos", "x-recurso": "ordens_servicos", "x-operacao": "deletar_anexo", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } }, { "name": "anexo_id", "in": "path", "required": true, "description": "Identificador do anexo", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/pedidos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Apaga o anexo e o arquivo. Anexo que não é deste pedido é 404. Exige a permissão de editar do tipo do pedido.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_ordens_servicos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar situações de OS", "operationId": "pedidos_situacoes_ordens_servicos_listar", "x-modulo": "pedidos", "x-recurso": "situacoes_ordens_servicos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome da situação", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Situações das ordens de serviço, para situacao_id de /ordens_servicos, do kanban, do painel e dos relatórios de O.S. Situações são cadastradas por cada empresa: o id muda de uma empresa para outra e o nome é o que o usuário vê — responda pelo nome e use o id em situacao_id. Vêm na ordem da tela; padrao 1 marca a situação padrão (uma só). A lista não diz quais situações a empresa escondeu da listagem. Nada encontrado volta 200 com data [] e message \"Não há dados!\". Venda e orçamento têm situações próprias (outros ids).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_ordens_servicos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar campos extras ordens serviço", "operationId": "pedidos_atributos_ordens_servicos_listar", "x-modulo": "pedidos", "x-recurso": "atributos_ordens_servicos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome do campo extra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Registro", "tipo": "numeros", "exibir_impressao": "Sim", "modificado_em": "2025-01-21 00:58:11", "cadastrado_em": "2025-01-21 00:58:11" }, { "id": "2", "nome": "Campo Aux", "tipo": "texto_simples", "exibir_impressao": "Não", "modificado_em": "2025-01-21 00:58:36", "cadastrado_em": "2025-01-21 00:58:36" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Campos extras que a empresa criou para as ordens de serviço (vendas, orçamentos e O.S. têm cada um os seus). No pedido de /ordens_servicos o valor vem em atributos, com atributo_id = o id daqui. Nenhum cadastrado volta 200 com data [] e message \"Nenhum campo extra foi encontrado!\": a empresa não usa campos extras ali, não é erro.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Cadastrar campos extras ordens serviço", "operationId": "pedidos_atributos_ordens_servicos_cadastrar", "x-modulo": "pedidos", "x-recurso": "atributos_ordens_servicos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Comprovante", "tipo": "check_list", "exibir_impressao": "Quando preenchido", "permitir_excluir": "1", "usuario_id": "131036", "nome_usuario": "Controle 1", "cadastrado_em": "2025-04-14 17:47:04", "modificado_em": "2025-04-14 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "PIX" }, { "id": "2", "atributo_id": "5", "nome": "Boleto" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Comprovante", "tipo": "check_list", "exibir_impressao": "Quando preenchido", "opcoes": [ { "nome": "PIX" }, { "nome": "Boleto" } ] } } } } } }, "/atributos_ordens_servicos/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar campos extras ordens serviço", "operationId": "pedidos_atributos_ordens_servicos_visualizar", "x-modulo": "pedidos", "x-recurso": "atributos_ordens_servicos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documento", "tipo": "check_list", "exibir_impressao": "Sim", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "CPF" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Editar campos extras ordens serviço", "operationId": "pedidos_atributos_ordens_servicos_editar", "x-modulo": "pedidos", "x-recurso": "atributos_ordens_servicos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "nome": "Documentos", "tipo": "numeros", "exibir_impressao": "Não", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "RG" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "exibir_impressao": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Documentos", "tipo": "check_list", "exibir_impressao": "Não", "opcoes": [ { "nome": "RG" }, { "nome": "CNH" } ] } } } } }, "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Deletar campos extras ordens serviço", "operationId": "pedidos_atributos_ordens_servicos_deletar", "x-modulo": "pedidos", "x-recurso": "atributos_ordens_servicos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Campo extra removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/canais_vendas": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar canais de venda", "operationId": "pedidos_canais_vendas_listar", "x-modulo": "pedidos", "x-recurso": "canais_vendas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial pelo nome", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "228703", "nome": "Presencial", "padrao": "1" }, { "id": "228704", "nome": "TESTE GCK-22594", "padrao": "0" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Canais de venda da empresa, para canal_venda_id dos relatórios (relatorio_vendas, de produtos e serviços vendidos, de O.S., curva ABC) e do kanban. padrao 1 = o canal que já vem nas vendas novas. A listagem /vendas não filtra por canal (canal_venda_id é ignorado sem aviso): para vendas de um canal use relatorio_vendas com canal_venda_id. Na venda o canal vem por nome, em nome_canal_venda.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Cadastrar canais de venda", "operationId": "pedidos_canais_vendas_cadastrar", "x-modulo": "pedidos", "x-recurso": "canais_vendas", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "228707", "nome": "Canal API 761761", "padrao": "0" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Campos aceitos: `nome` e `padrao` (1 = canal padrão das vendas novas; marcar um tira a marca do anterior). Nome repetido é recusado.\n\n**Campos obrigatórios:** `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "padrao": { "type": "integer" } } }, "example": { "nome": "Canal API 761761", "padrao": 0 } } } } } }, "/canais_vendas/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar canais de venda", "operationId": "pedidos_canais_vendas_visualizar", "x-modulo": "pedidos", "x-recurso": "canais_vendas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "228707", "nome": "Canal API 761761", "padrao": "0" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Editar canais de venda", "operationId": "pedidos_canais_vendas_editar", "x-modulo": "pedidos", "x-recurso": "canais_vendas", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "228707", "nome": "Canal API 761761 editado", "padrao": "0" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Campos aceitos: `nome` e `padrao`. O canal padrão continua padrão mesmo sem `padrao` no corpo.\n\n**Campos obrigatórios:** `nome`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "padrao": { "type": "integer" } } }, "example": { "nome": "Canal API 761761 editado", "padrao": 0 } } } } }, "delete": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Deletar canais de venda", "operationId": "pedidos_canais_vendas_deletar", "x-modulo": "pedidos", "x-recurso": "canais_vendas", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Canal de venda removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "O canal padrão não pode ser excluído.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/devolucoes": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Listar trocas e devoluções", "operationId": "pedidos_devolucoes_listar", "x-modulo": "pedidos", "x-recurso": "devolucoes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (registro da troca ou devolução)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "codigo_pedido", "in": "query", "required": false, "description": "código (número) do pedido de ORIGEM — a venda ou O.S. de onde os itens voltaram, não o código da devolução", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "número com ponto decimal (ex.: 100.50) — valor total mínimo da troca ou devolução", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "número com ponto decimal — valor total máximo", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "devolucoes": { "type": "integer" }, "trocas": { "type": "integer" }, "valor_total": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data em que a troca ou devolução foi registrada (cadastrado_em)", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 5, "total_paginas": 0, "cache": false }, "data": { "totais": { "quantidade": 0, "devolucoes": 0, "trocas": 0, "valor_total": 0 }, "itens": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/Devolucoes/index", "x-periodo": { "data": "a data em que a troca ou devolução foi registrada (cadastrado_em)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Cada item é uma troca (tipo TR) ou devolução (tipo DE) — tipo_descricao diz qual. valor_total é o valor da troca ou devolução; pedido_origem traz o id e o código do pedido de onde os itens voltaram e nome_situacao é a situação ATUAL desse pedido de origem, não da devolução. lancado_estoque/lancado_financeiro dizem se a devolução já mexeu no estoque e no financeiro. data.totais conta o período inteiro (quantidade, devolucoes, trocas, valor_total); data.itens é só uma página — nunca some as linhas. A data do período é a do registro (cadastrado_em), não a da venda. Não há motivo da devolução registrado. Para os itens devolvidos use /devolucoes/{id}.", "description": "Trocas e devoluções de venda registradas no período (Vendas > Trocas e devoluções), com o pedido de origem, o cliente, a loja e o valor; e o detalhe de uma delas com os itens devolvidos, as parcelas e o vale-compra gerado. É a mesma regra da tela. Só leitura: registrar e cancelar ficam na tela. Para os totais por forma de pagamento use /relatorios/devolucoes.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data em que a troca ou devolução foi registrada (cadastrado_em). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/Devolucoes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/devolucoes/{id}": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Visualizar trocas e devoluções", "operationId": "pedidos_devolucoes_visualizar", "x-modulo": "pedidos", "x-recurso": "devolucoes", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "tipo_descricao": { "type": "string" }, "data": { "type": "string" }, "cadastrado_em": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "nota_fiscal_id": { "type": [ "string", "null" ] }, "valor_total": { "type": "integer" }, "lancado_estoque": { "type": "boolean" }, "lancado_financeiro": { "type": "boolean" }, "modificado_em": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "valor_produtos": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "valor_frete": { "type": "integer" }, "valor_acrescimo": { "type": [ "string", "null" ] }, "valor_outros": { "type": "integer" }, "pedido_origem": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "tipo": { "type": "string" }, "produto_id": { "type": "string" }, "codigo_produto": { "type": "string" }, "nome_produto": { "type": "string" }, "nome_variacao": { "type": [ "string", "null" ] }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_venda": { "type": "integer" }, "desconto_valor": { "type": [ "string", "null" ] }, "valor_total": { "type": "integer" }, "numero_lote": { "type": [ "string", "null" ] }, "data_fabricacao": { "type": [ "string", "null" ] }, "data_validade": { "type": [ "string", "null" ] } } } }, "parcelas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "integer" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "observacao": { "type": [ "string", "null" ] } } } }, "vale_compra": { "type": [ "string", "null" ] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "7130", "codigo": "12", "tipo": "DE", "tipo_descricao": "Devolução", "data": "2026-09-26", "cadastrado_em": "2026-09-26 15:42:10", "loja_id": "65", "nome_loja": "Master", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "nota_fiscal_id": null, "valor_total": 15, "lancado_estoque": true, "lancado_financeiro": true, "modificado_em": "2026-09-26 15:42:10", "vendedor_id": "130854", "nome_vendedor": "Usuário", "usuario_id": "130854", "nome_usuario": "Usuário", "valor_produtos": 15, "valor_servicos": 0, "desconto_valor": 0, "valor_frete": 0, "valor_acrescimo": null, "valor_outros": 0, "pedido_origem": { "id": "7120", "codigo": "9225941", "tipo": "PP", "data": "2026-09-24", "situacao_id": "3287860", "nome_situacao": "Confirmado" }, "produtos": [ { "id": "213321140", "tipo": "P", "produto_id": "31998", "codigo_produto": "2050460512009", "nome_produto": "Coca cola", "nome_variacao": null, "sigla_unidade": "UN", "quantidade": 1, "valor_venda": 15, "desconto_valor": null, "valor_total": 15, "numero_lote": null, "data_fabricacao": null, "data_validade": null } ], "parcelas": [ { "id": "8270", "data_vencimento": "2026-09-26", "valor": 15, "forma_pagamento_id": "646904", "nome_forma_pagamento": "Dinheiro à Vista", "observacao": null } ], "vale_compra": null } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/Devolucoes/visualizar", "x-ia": "Uma troca ou devolução das lojas do usuário da chave (404 se for de outra empresa, de loja que ele não acessa ou se o id for de uma venda comum). produtos são os itens que voltaram (tipo P = produto, S = serviço), com quantidade, valor_venda e valor_total; parcelas é como o valor foi devolvido ao cliente (forma de pagamento e vencimento). pedido_origem traz o pedido de onde os itens vieram e a situação atual dele. vale_compra só vem quando o valor virou vale-compra (saldo é o que ainda resta do vale). O custo dos itens não sai.", "description": "**Permissão exigida:** `Vendas/Devolucoes/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ordens_servicos/kanban": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar quadro (kanban) de ordens de serviço", "operationId": "pedidos_ordens_servicos_kanban_listar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos_kanban", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S.)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações a contar (ids em /situacoes_ordens_servicos); as demais colunas visíveis vêm com zero, e uma situação escondida da listagem só aparece se estiver aqui — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — O.S. de um cliente", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "tecnico_id", "in": "query", "required": false, "description": "int — um técnico (principal ou vinculado à O.S.)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" } } }, "colunas": { "type": "array", "items": { "type": "object", "properties": { "situacao_id": { "type": "integer" }, "nome": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "integer" }, "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de entrada da O.S.", "inicio": "2025-07-01", "fim": "2025-07-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "cache": false }, "data": { "totais": { "quantidade": 2, "valor_total": 850 }, "colunas": [ { "situacao_id": 3287864, "nome": "Em andamento TESTE GCK-22721", "cor": "#f0ad4e", "ordem": 1, "quantidade": 1, "valor_total": 350 }, { "situacao_id": 3287865, "nome": "Finalizada TESTE GCK-22721", "cor": "#5cb85c", "ordem": 2, "quantidade": 1, "valor_total": 500 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Ordens/OrdensServicos/index", "x-periodo": { "data": "a data de entrada da O.S.", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Use para 'quantas O.S. tenho em cada situação e quanto valem'. Os totais já vêm somados em data.totais (quantidade e valor_total do quadro) e por coluna em data.colunas — não some você. valor_total é a soma do valor total das O.S. (não das parcelas: difere do faturamento do /ordens_servicos/painel). O período é a data de ENTRADA da O.S. (padrão mês atual): uma O.S. antiga parada numa situação só conta se o período a incluir. Para listar as O.S. de uma coluna: GET /ordens_servicos?situacao_id=.", "description": "As colunas do quadro de ordens de serviço (modo kanban da listagem): cada situação de O.S. com a quantidade e o valor das O.S. do período, e o total do quadro. É a mesma regra das colunas da tela. As O.S. de uma coluna estão na listagem (/ordens_servicos?situacao_id=).\n\nSó entram as colunas das situações marcadas para aparecer na listagem (ou pedidas em situacao_id), na ordem da tela. Sem a permissão Ordens/OrdensServicos/liberado_usuario, contam só as O.S. do próprio usuário (cadastradas por ele, como vendedor ou técnico).\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S.. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Ordens/OrdensServicos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ordens_servicos/painel": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar painel de ordens de serviço", "operationId": "pedidos_ordens_servicos_painel_listar", "x-modulo": "pedidos", "x-recurso": "ordens_servicos_painel", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S.) dos prazos e prioridades", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — a loja do painel; sem ele, a loja padrão do usuário da chave (o painel é sempre de uma loja só, como na tela)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações de O.S. que entram nos prazos e nas prioridades (ids em /situacoes_ordens_servicos); sem ele entram todas — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — O.S. de um cliente", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — O.S. de um vendedor (na tela, também restringe a lista de técnicos do faturamento por técnico a esse id)", "schema": { "type": "string" } }, { "name": "tecnico_id", "in": "query", "required": false, "description": "int — O.S. de um técnico (principal ou vinculado)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "loja": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" } } }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" } } } }, "prazos": { "type": "object", "properties": { "vencidas": { "type": "integer" }, "hoje": { "type": "integer" }, "amanha": { "type": "integer" }, "futuras": { "type": "integer" }, "sem_prazo": { "type": "integer" } } }, "prioridades": { "type": "object", "properties": { "baixa": { "type": "integer" }, "media": { "type": "integer" }, "alta": { "type": "integer" }, "urgente": { "type": "integer" }, "muito_urgente": { "type": "integer" }, "sem_prioridade": { "type": "integer" } } }, "faturamento_mensal": { "type": "object", "properties": { "inicio": { "type": "string" }, "fim": { "type": "string" }, "valor_total": { "type": "integer" }, "media_mensal": { "type": "integer" }, "quantidade": { "type": "integer" }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" } } } }, "meses": { "type": "array", "items": { "type": "object", "properties": { "mes": { "type": "string" }, "valor": { "type": "integer" } } } } } }, "faturamento_tecnicos": { "type": "object", "properties": { "inicio": { "type": "string" }, "fim": { "type": "string" }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" } } } }, "tecnicos": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "quantidade": { "type": "integer" }, "valor": { "type": "integer" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de entrada da O.S. (prazos e prioridades)", "inicio": "2025-07-01", "fim": "2025-07-31", "padrao": false }, "cache": false }, "data": { "loja": { "id": 65, "nome": "Master" }, "situacoes": [ { "id": 3287864, "nome": "Em andamento TESTE GCK-22721" }, { "id": 3287865, "nome": "Finalizada TESTE GCK-22721" } ], "prazos": { "vencidas": 1, "hoje": 0, "amanha": 0, "futuras": 0, "sem_prazo": 1 }, "prioridades": { "baixa": 0, "media": 0, "alta": 1, "urgente": 1, "muito_urgente": 0, "sem_prioridade": 0 }, "faturamento_mensal": { "inicio": "2026-05", "fim": "2026-10", "valor_total": 0, "media_mensal": 0, "quantidade": 0, "situacoes": [ { "id": 3287865, "nome": "Finalizada TESTE GCK-22721" } ], "meses": [ { "mes": "2026-05", "valor": 0 }, { "mes": "2026-06", "valor": 0 }, { "mes": "2026-07", "valor": 0 }, { "mes": "2026-08", "valor": 0 }, { "mes": "2026-09", "valor": 0 }, { "mes": "2026-10", "valor": 0 } ] }, "faturamento_tecnicos": { "inicio": "2026-05", "fim": "2026-10", "situacoes": [ { "id": 3287865, "nome": "Finalizada TESTE GCK-22721" } ], "tecnicos": [ { "nome": "João do BD COMPARTILHADO!", "quantidade": 0, "valor": 0 }, { "nome": "Funcionário editado", "quantidade": 0, "valor": 0 }, { "nome": "Funcionário Teste", "quantidade": 0, "valor": 0 }, { "nome": "FUNC COMPROMISSO", "quantidade": 0, "valor": 0 }, { "nome": "arthur loja", "quantidade": 0, "valor": 0 }, { "nome": "Permission", "quantidade": 0, "valor": 0 }, { "nome": "Filisbino", "quantidade": 0, "valor": 0 }, { "nome": "Arthur Folco", "quantidade": 0, "valor": 0 }, { "nome": "lolan", "quantidade": 0, "valor": 0 }, { "nome": "EXTERIOR", "quantidade": 0, "valor": 0 }, { "nome": "User TestPermissoes", "quantidade": 0, "valor": 0 }, { "nome": "nasclolan", "quantidade": 0, "valor": 0 }, { "nome": "sem acesso ao sistema", "quantidade": 0, "valor": 0 }, { "nome": "teste funcionario", "quantidade": 0, "valor": 0 }, { "nome": "cadastro por controle de bens", "quantidade": 0, "valor": 0 }, { "nome": "O fim é triste", "quantidade": 0, "valor": 0 }, { "nome": "Bens", "quantidade": 0, "valor": 0 }, { "nome": "Jurubeba", "quantidade": 0, "valor": 0 }, { "nome": "outros testes", "quantidade": 0, "valor": 0 }, { "nome": "jogos", "quantidade": 0, "valor": 0 }, { "nome": "MAIS UM", "quantidade": 0, "valor": 0 }, { "nome": "MDFE CADASTRO", "quantidade": 0, "valor": 0 }, { "nome": "aqui", "quantidade": 0, "valor": 0 }, { "nome": "JJ", "quantidade": 0, "valor": 0 }, { "nome": "Joselito", "quantidade": 0, "valor": 0 }, { "nome": "aaaaaaa", "quantidade": 0, "valor": 0 }, { "nome": "Lola teste", "quantidade": 0, "valor": 0 }, { "nome": "Berilo", "quantidade": 0, "valor": 0 }, { "nome": "Hylário", "quantidade": 0, "valor": 0 }, { "nome": "teste1", "quantidade": 0, "valor": 0 }, { "nome": "LolaNasc", "quantidade": 0, "valor": 0 }, { "nome": "ThyTest", "quantidade": 0, "valor": 0 }, { "nome": "André Souza", "quantidade": 0, "valor": 0 }, { "nome": "Adson", "quantidade": 0, "valor": 0 }, { "nome": "Tester de permissoes", "quantidade": 0, "valor": 0 }, { "nome": "Usuário IUGU", "quantidade": 0, "valor": 0 }, { "nome": "Renato Souza", "quantidade": 0, "valor": 0 }, { "nome": "Usuário", "quantidade": 0, "valor": 0 }, { "nome": "João do BD COMPARTILHADO!", "quantidade": 0, "valor": 0 }, { "nome": "Vendedor / Resposável", "quantidade": 0, "valor": 0 }, { "nome": "Hotmart", "quantidade": 0, "valor": 0 } ] } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Ordens/OrdensServicosPainel/index", "x-periodo": { "data": "a data de entrada da O.S. (só prazos e prioridades)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Use para 'quantas O.S. estão atrasadas / vencem hoje / estão urgentes'. prazos olha a data de saída prevista (previsão de entrega) das O.S. que ENTRARAM no período: vencidas = previsão antes de hoje (mesmo as já finalizadas, se a situação estiver em data.situacoes — filtre situacao_id para só as em aberto); futuras = depois de amanhã até data_fim. prioridades: baixa, media, alta, urgente, muito_urgente e sem_prioridade. faturamento_mensal e faturamento_tecnicos NÃO seguem o período: são sempre os últimos 6 meses (inicio/fim do bloco), só das situações que lançam (bloco situacoes), e o valor é a soma das parcelas (O.S. sem parcela conta na quantidade com valor 0). O painel é de uma loja (data.loja); para outra, repita com loja_id. Para valor por situação use /ordens_servicos/kanban; para totais do período, /relatorios/ordens_servicos.", "description": "Os números da tela Ordens de serviço > Painel de uma loja: quantas O.S. estão com o prazo vencido, vencendo hoje, amanhã, mais adiante ou sem prazo; quantas há em cada prioridade; o faturamento das O.S. mês a mês e o faturamento de cada técnico nos últimos 6 meses. É a mesma regra do painel da tela.\n\nCada bloco vem null quando o usuário da chave não tem a permissão que a tela exige para mostrá-lo: prazos (Ordens/OrdensServicosPainel/painel_mostrar_prazos), prioridades (painel_mostrar_prioridades), faturamento_mensal (painel_mostrar_vendas_aprovadas) e faturamento_tecnicos (painel_mostrar_vendas_funcionarios). Sem a permissão Ordens/OrdensServicos/liberado_usuario, prazos, prioridades e faturamento por técnico contam só as O.S. do próprio usuário. A escolha de situações salva na tela não é usada nem alterada.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S. (só prazos e prioridades). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Ordens/OrdensServicosPainel/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/clientes_mais_compram": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de clientes que mais compram", "operationId": "pedidos_relatorio_clientes_mais_compram_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_clientes_mais_compram", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da venda (ids em /situacoes_vendas; venda e O.S. têm ids diferentes — sem ele entram todas as situações visíveis, de venda e de O.S.) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — vendas que têm este produto", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendas destes vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "ordenar_por", "in": "query", "required": false, "description": "V = pelo valor comprado, Q = pela quantidade de pedidos (padrão)", "schema": { "type": "string" } }, { "name": "exibir_devolucoes", "in": "query", "required": false, "description": "1 = inclui as devoluções (bem mais lento) (0 ou 1)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "ordenar_por": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "cpf_cnpj": { "type": [ "string", "null" ] }, "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da venda", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "ordenar_por": "V" }, "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "itens": [ { "nome": "Cliente TESTE SR", "cpf_cnpj": null, "quantidade": 18, "valor_total": 2840 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_clientes_mais_compram", "x-periodo": { "data": "a data da venda", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Cada item traz nome, quantidade (pedidos) e valor_total (soma das parcelas): responda nome, valor e quantidade juntos. NÃO há total geral — o consolidado do período sai do relatório de vendas; se somar a lista, diga que a soma foi sua, e lembre que data.itens é só uma página (meta.total_registros = quantos clientes). Mande sempre ordenar_por: sem ele a ordem é por quantidade de pedidos. Venda sem cliente não entra. Sem situacao_id entram todas as situações visíveis, misturando venda e O.S. Cliente com valor 0 é pedido sem parcela lançada, não 'comprou zero'. cpf_cnpj costuma vir nulo e o item não traz o id do cliente. É venda, não nota fiscal. situacao_id e vendedor_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Ranking dos clientes no período: quantos pedidos cada um fez e quanto comprou. É a mesma regra do relatório de clientes que mais compram da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_clientes_mais_compram` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/comissao_produto": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de comissão por produto", "operationId": "pedidos_relatorio_comissao_produto_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_comissao_produto", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "entrega_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da previsão de entrega (com entrega_fim); filtra junto com o período da venda", "schema": { "type": "string" } }, { "name": "entrega_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da previsão de entrega", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da venda (ids em /situacoes_vendas; venda e O.S. têm ids diferentes — sem ele entram todas as situações visíveis, de venda e de O.S.) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — vendas de um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — só este produto", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de produto (inclui os subgrupos); SG = produtos sem grupo", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — só produtos deste fornecedor", "schema": { "type": "string" } }, { "name": "comissao_regra", "in": "query", "required": false, "description": "F, P, U ou R — regra de liberação gravada na venda (venda sem esse registro fica de fora)", "schema": { "type": "string" } }, { "name": "comissao_status", "in": "query", "required": false, "description": "pendente, parcial, liberada ou cancelado — situação da liberação (venda sem esse registro fica de fora)", "schema": { "type": "string" } }, { "name": "exibir_devolucoes", "in": "query", "required": false, "description": "1 = inclui as devoluções (mais lento) (0 ou 1)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "valor_total": { "type": "integer" }, "liberacao": { "type": "object", "properties": { "liberada": { "type": "object", "properties": { "valor": { "type": "number" }, "proporcao": { "type": "integer" } } }, "pendente": { "type": "object", "properties": { "valor": { "type": "integer" }, "proporcao": { "type": "integer" } } }, "devido": { "type": "number" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "grupo": { "type": "string" }, "valor_custo_produto": { "type": "integer" }, "comissao": { "type": "integer" }, "comissao_vendedor": { "type": "integer" }, "quantidade": { "type": "integer" }, "desconto": { "type": "integer" }, "frete": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_venda": { "type": "number" }, "valor_total": { "type": "integer" }, "comissao_percentual": { "type": "integer" }, "comissao_valor": { "type": "integer" }, "comissao_x_comissao_vendedor": { "type": "integer" }, "comissao_x_comissao_vendedor_valor": { "type": "integer" } } } }, "totais": { "type": "object", "properties": { "qtd_vendas": { "type": "integer" }, "quantidade": { "type": "integer" }, "total": { "type": "integer" }, "total_comissao_valor": { "type": "integer" }, "total_comissao_percentual": { "type": "integer" }, "total_comissao_x_comissao_vendedor": { "type": "integer" }, "total_comissao_x_comissao_vendedor_valor": { "type": "integer" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da venda", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "valor_total": 2750, "liberacao": { "liberada": { "valor": 18022.8199999999997089616954326629638671875, "proporcao": 100 }, "pendente": { "valor": 0, "proporcao": 0 }, "devido": 18022.8199999999997089616954326629638671875 } }, "itens": [ { "id": "45", "nome": "JOÃO DO BD COMPARTILHADO!", "produtos": [ { "codigo": "2050460512009", "nome": "Coca cola", "grupo": "", "valor_custo_produto": 10, "comissao": 0, "comissao_vendedor": 1000, "quantidade": 10, "desconto": 0, "frete": 0, "valor_custo": 100, "valor_venda": 52.5, "valor_total": 105, "comissao_percentual": 0, "comissao_valor": 0, "comissao_x_comissao_vendedor": 0, "comissao_x_comissao_vendedor_valor": 0 } ], "totais": { "qtd_vendas": 17, "quantidade": 10, "total": 105, "total_comissao_valor": 0, "total_comissao_percentual": 0, "total_comissao_x_comissao_vendedor": 0, "total_comissao_x_comissao_vendedor_valor": 0 } }, { "id": "130854", "nome": "USUÁRIO", "produtos": [ { "codigo": "2050460512009", "nome": "Coca cola", "grupo": "", "valor_custo_produto": 10, "comissao": 0, "comissao_vendedor": 10, "quantidade": 2, "desconto": 0, "frete": 0, "valor_custo": 20, "valor_venda": 30, "valor_total": 30, "comissao_percentual": 0, "comissao_valor": 0, "comissao_x_comissao_vendedor": 0, "comissao_x_comissao_vendedor_valor": 0 } ], "totais": { "qtd_vendas": 2, "quantidade": 2, "total": 30, "total_comissao_valor": 0, "total_comissao_percentual": 0, "total_comissao_x_comissao_vendedor": 0, "total_comissao_x_comissao_vendedor_valor": 0 } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_comissao_produto", "x-periodo": { "data": "a data da venda", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "entrega_inicio", "fim": "entrega_fim", "data": "a previsão de entrega da venda", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Cada item é um VENDEDOR {id, nome, produtos, totais}: responda por vendedor 'vendeu R$ X (totais.total), comissão R$ Y (totais.total_comissao_valor)'. data.totais.valor_total é o valor total dos PEDIDOS do período, não dos produtos, e não existe comissão total geral pronta: some total_comissao_valor dos vendedores e diga que a soma foi sua — e só de todas as páginas de data.itens. data.totais.liberacao (devido/liberado/pendente) é no grão do pedido, não fecha 1:1 com a comissão por produto. Para quanto cada pessoa recebe no total use o relatório de comissão de vendedores; para serviços, o de comissão por serviço. Custo só se a chave tiver a permissão de ver custo. entrega_inicio/entrega_fim filtram a PREVISÃO DE ENTREGA da venda e se somam ao período da venda (data_inicio/data_fim, que tem padrão mês atual): só entram vendas feitas no período E com entrega prevista no intervalo; venda sem previsão de entrega fica de fora. Para \"o que tenho para entregar\" amplie data_inicio/data_fim (até 12 meses) para alcançar vendas antigas. Devolução não tem entrega: com exibir_devolucoes=1, o intervalo de entrega passa a filtrar a data da devolução (regra da tela). situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Comissão por produto vendido no período, agrupada por vendedor: para cada vendedor, os produtos com quantidade, valor e comissão, e os totais dele. É a mesma regra do relatório de comissão por produto da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `entrega_inicio` e `entrega_fim` (AAAA-MM-DD, juntos) filtram a previsão de entrega da venda. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_comissao_produto` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/comissao_servico": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de comissão por serviço", "operationId": "pedidos_relatorio_comissao_servico_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_comissao_servico", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "entrega_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da previsão de entrega (com entrega_fim); filtra junto com o período da venda", "schema": { "type": "string" } }, { "name": "entrega_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da previsão de entrega", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da venda (ids em /situacoes_vendas; venda e O.S. têm ids diferentes — sem ele entram todas as situações visíveis, de venda e de O.S.) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — vendas de um cliente", "schema": { "type": "string" } }, { "name": "servico_id", "in": "query", "required": false, "description": "int — só este serviço", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "comissao_regra", "in": "query", "required": false, "description": "F, P, U ou R — regra de liberação gravada na venda (venda sem esse registro fica de fora)", "schema": { "type": "string" } }, { "name": "comissao_status", "in": "query", "required": false, "description": "pendente, parcial, liberada ou cancelado — situação da liberação (venda sem esse registro fica de fora)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "liberacao": { "type": "object", "properties": { "liberada": { "type": "object", "properties": { "valor": { "type": "number" }, "proporcao": { "type": "integer" } } }, "pendente": { "type": "object", "properties": { "valor": { "type": "integer" }, "proporcao": { "type": "integer" } } }, "devido": { "type": "number" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "grupo": { "type": [ "string", "null" ] }, "comissao": { "type": [ "string", "null" ] }, "valor_custo_produto": { "type": "integer" }, "comissao_vendedor": { "type": "integer" }, "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" }, "comissao_media": { "type": "integer" }, "comissao_x_comissao_vendedor": { "type": "integer" } } } }, "totais": { "type": "object", "properties": { "total": { "type": "integer" }, "comissao": { "type": "integer" }, "quantidade": { "type": "integer" }, "comissao_x_comissao_vendedor": { "type": "integer" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da venda", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "liberacao": { "liberada": { "valor": 18021.3199999999997089616954326629638671875, "proporcao": 100 }, "pendente": { "valor": 0, "proporcao": 0 }, "devido": 18021.3199999999997089616954326629638671875 } }, "itens": [ { "id": 45, "nome": "JOÃO DO BD COMPARTILHADO!", "servicos": [ { "codigo": "2042423891504", "nome": "Hospedagem de sites", "grupo": null, "comissao": null, "valor_custo_produto": 100, "comissao_vendedor": 1000, "quantidade": 12, "valor_total": 2520, "comissao_media": 0, "comissao_x_comissao_vendedor": 0 } ], "totais": { "total": 2520, "comissao": 0, "quantidade": 12, "comissao_x_comissao_vendedor": 0 } }, { "id": 130854, "nome": "USUÁRIO", "servicos": [ { "codigo": "2042423891504", "nome": "Hospedagem de sites", "grupo": null, "comissao": null, "valor_custo_produto": 100, "comissao_vendedor": 10, "quantidade": 1, "valor_total": 200, "comissao_media": 0, "comissao_x_comissao_vendedor": 0 } ], "totais": { "total": 200, "comissao": 0, "quantidade": 1, "comissao_x_comissao_vendedor": 0 } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_comissao_servico", "x-periodo": { "data": "a data da venda", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "entrega_inicio", "fim": "entrega_fim", "data": "a previsão de entrega da venda", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Cada item é um VENDEDOR {id, nome, servicos, totais}: responda por vendedor 'vendeu R$ X (totais.total), comissão R$ Y (totais.comissao)'. NÃO há total geral de comissão: some os vendedores de todas as páginas e diga que a soma foi sua. data.totais.liberacao (devido/liberado/pendente) é no grão do pedido e não mapeia 1:1 por serviço; use só para 'o que já pode ser pago'. Para produtos use o relatório de comissão por produto; para o total de cada pessoa, o de comissão de vendedores. entrega_inicio/entrega_fim filtram a PREVISÃO DE ENTREGA da venda e se somam ao período da venda (data_inicio/data_fim, que tem padrão mês atual): só entram vendas feitas no período E com entrega prevista no intervalo; venda sem previsão de entrega fica de fora. Para \"o que tenho para entregar\" amplie data_inicio/data_fim (até 12 meses) para alcançar vendas antigas. situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Comissão por serviço vendido no período, agrupada por vendedor: para cada vendedor, os serviços com quantidade, valor e comissão, e os totais dele. É a mesma regra do relatório de comissão por serviço da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `entrega_inicio` e `entrega_fim` (AAAA-MM-DD, juntos) filtram a previsão de entrega da venda. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_comissao_servico` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/comissao_tecnicos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de comissão de técnicos", "operationId": "pedidos_relatorio_comissao_tecnicos_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_comissao_tecnicos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S.)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "saida_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de saída da O.S. (com saida_fim); filtra junto com o período de entrada", "schema": { "type": "string" } }, { "name": "saida_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de saída", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da O.S. (ids em /situacoes_ordens_servicos); sem ele entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — O.S. de um cliente", "schema": { "type": "string" } }, { "name": "tecnico_id", "in": "query", "required": false, "description": "int — um técnico só (resposta bem menor)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "tipo_comissao", "in": "query", "required": false, "description": "P = comissiona só o valor de produtos (peças), S = só o de serviços, PS = os dois (padrão)", "schema": { "type": "string" } }, { "name": "comissao_regra", "in": "query", "required": false, "description": "regra de liberação gravada na O.S.: F = integral ao gerar o financeiro, P = integral na 1ª parcela, U = integral na última, R = parcial conforme o recebimento. O.S. sem esse registro fica de fora", "schema": { "type": "string" } }, { "name": "comissao_status", "in": "query", "required": false, "description": "pendente, parcial, liberada ou cancelado — situação da liberação da comissão. O.S. sem esse registro fica de fora", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "total_vendido": { "type": "integer" }, "total_comissoes": { "type": "integer" }, "total_comissoes_liberadas": { "type": "integer" }, "total_comissoes_pendentes": { "type": "integer" }, "quantidade_tecnicos": { "type": "integer" }, "quantidade_vendas": { "type": "integer" }, "total_comissoes_brutas": { "type": "number" }, "liberacao": { "type": "object", "properties": { "liberada": { "type": "object", "properties": { "valor": { "type": "integer" }, "proporcao": { "type": "integer" } } }, "pendente": { "type": "object", "properties": { "valor": { "type": "integer" }, "proporcao": { "type": "integer" } } }, "devido": { "type": "integer" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "vendas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome_loja": { "type": "string" }, "hash": { "type": "string" }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_frete": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_total": { "type": "integer" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "tecnico_id": { "type": "string" }, "usuario_id": { "type": "string" }, "tipo": { "type": "string" }, "data_confirmacao": { "type": "string" }, "cor_situacao": { "type": "string" }, "valor_total_calculado": { "type": "integer" }, "valor_media_calculado": { "type": "integer" }, "nome_vendedor": { "type": "string" }, "comissao_regra": { "type": "string" }, "comissao_status": { "type": "string" }, "comissao_status_chave": { "type": "string" }, "comissao_devida": { "type": "integer" }, "comissao_liberada": { "type": "integer" }, "comissao_pendente": { "type": "integer" }, "comissao_legado": { "type": "boolean" }, "comissao_porcentagem": { "type": "number" }, "comissao_bruta": { "type": "number" }, "comissao_liquida": { "type": "integer" }, "valor_comissao": { "type": "integer" }, "usuarios": { "type": "object", "properties": { "id": { "type": "string" }, "comissao": { "type": "integer" } } } } } }, "totais": { "type": "object", "properties": { "total": { "type": "integer" }, "comissao": { "type": "integer" }, "comissao_bruta": { "type": "number" }, "comissao_liquida": { "type": "integer" }, "comissao_devida": { "type": "integer" }, "comissao_liberada": { "type": "integer" }, "comissao_pendente": { "type": "integer" }, "quantidade_vendas": { "type": "integer" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de entrada da O.S.", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "total_vendido": 120, "total_comissoes": 0, "total_comissoes_liberadas": 0, "total_comissoes_pendentes": 0, "quantidade_tecnicos": 1, "quantidade_vendas": 1, "total_comissoes_brutas": 1199.990000000000009094947017729282379150390625, "liberacao": { "liberada": { "valor": 0, "proporcao": 0 }, "pendente": { "valor": 0, "proporcao": 0 }, "devido": 0 } }, "itens": [ { "id": "45", "nome": "JOÃO DO BD COMPARTILHADO!", "vendas": [ { "id": "7116", "codigo": "173", "nome_loja": "Master", "hash": "QWLb", "data": "2026-09-28", "previsao_entrega": null, "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": "45", "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#6c757d", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "valor_comissao": 0, "usuarios": { "id": "45", "comissao": 1000 } } ], "totais": { "total": 120, "comissao": 0, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "quantidade_vendas": 1 } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Ordens/RelatoriosOrdensServicos/relatorio_comissao_tecnicos", "x-periodo": { "data": "a data de entrada da O.S.", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "saida_inicio", "fim": "saida_fim", "data": "a data de saída da O.S. (previsão de saída)", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Responda por técnico 'atendeu R$ X, comissão R$ Y' com totais.total e totais.comissao_devida de cada item, e o total com data.totais (total_vendido e total_comissoes). A base é a data de ENTRADA da O.S., não o recebimento. Uma O.S. com dois técnicos entra para cada um, então somar total_vendido dos técnicos pode passar do valor das O.S. total_comissoes é o devido (já sem comissão cancelada); total_comissoes_brutas é a porcentagem sobre o valor cheio. data.totais.liberacao (liberada/pendente/devido) responde 'o que já pode ser pago'. Comissão 0 é normal: técnico sem porcentagem. data.itens é uma página de TÉCNICOS (cada um com suas O.S.). saida_inicio/saida_fim filtram a DATA DE SAÍDA da O.S. (a \"Data de saída\" da tela) e se somam ao período de entrada (data_inicio/data_fim, que tem padrão mês atual): só entram O.S. abertas no período E com saída no intervalo; O.S. sem data de saída fica de fora. Para O.S. antigas com saída agora, amplie data_inicio/data_fim (até 12 meses). situacao_id aceita vários ids (situacao_id=1,2; um id só continua valendo) e volta como lista em meta.filtros; tecnico_id segue com um id só.", "description": "Comissão dos técnicos nas ordens de serviço do período, agrupada por técnico: para cada um, as O.S. com valor, comissão e situação da liberação, e os totais dele. É a mesma regra do relatório de comissão de técnicos da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S.. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `saida_inicio` e `saida_fim` (AAAA-MM-DD, juntos) filtram a data de saída da O.S. (previsão de saída). Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Ordens/RelatoriosOrdensServicos/relatorio_comissao_tecnicos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/comissao_vendedores": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de comissão de vendedores", "operationId": "pedidos_relatorio_comissao_vendedores_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_comissao_vendedores", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "entrega_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da previsão de entrega (com entrega_fim); filtra junto com o período da venda", "schema": { "type": "string" } }, { "name": "entrega_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da previsão de entrega", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da venda (ids em /situacoes_vendas; venda e O.S. têm ids diferentes — sem ele entram todas as situações visíveis, de venda e de O.S.) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — vendas de um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — vendas que têm este produto", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores (com um só, a resposta fica bem menor) — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "tipo_comissao", "in": "query", "required": false, "description": "P = comissiona só o valor de produtos, S = só o de serviços, PS = os dois (padrão)", "schema": { "type": "string" } }, { "name": "comissao_regra", "in": "query", "required": false, "description": "regra de liberação gravada na venda: F = integral ao gerar o financeiro, P = integral na 1ª parcela, U = integral na última, R = parcial conforme o recebimento. Venda sem esse registro fica de fora", "schema": { "type": "string" } }, { "name": "comissao_status", "in": "query", "required": false, "description": "pendente, parcial, liberada ou cancelado — situação da liberação da comissão. Venda sem esse registro fica de fora", "schema": { "type": "string" } }, { "name": "exibir_devolucoes", "in": "query", "required": false, "description": "1 = desconta a comissão das devoluções (entram com sinal negativo) (0 ou 1)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "total_vendido": { "type": "integer" }, "total_comissoes": { "type": "number" }, "total_comissoes_brutas": { "type": "number" }, "total_comissoes_liberadas": { "type": "number" }, "total_comissoes_pendentes": { "type": "integer" }, "quantidade_vendedores": { "type": "integer" }, "quantidade_vendas": { "type": "integer" }, "liberacao": { "type": "object", "properties": { "liberada": { "type": "object", "properties": { "valor": { "type": "number" }, "proporcao": { "type": "integer" } } }, "pendente": { "type": "object", "properties": { "valor": { "type": "integer" }, "proporcao": { "type": "integer" } } }, "devido": { "type": "number" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "vendas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome_loja": { "type": "string" }, "hash": { "type": "string" }, "data": { "type": "string" }, "previsao_entrega": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_frete": { "type": [ "string", "null" ] }, "valor_produtos": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_total": { "type": "integer" }, "cliente_id": { "type": [ "string", "null" ] }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "tecnico_id": { "type": [ "string", "null" ] }, "usuario_id": { "type": "string" }, "tipo": { "type": "string" }, "data_confirmacao": { "type": "string" }, "cor_situacao": { "type": "string" }, "valor_total_calculado": { "type": "integer" }, "valor_media_calculado": { "type": "number" }, "nome_vendedor": { "type": "string" }, "comissao_regra": { "type": "string" }, "comissao_status": { "type": "string" }, "comissao_status_chave": { "type": "string" }, "comissao_devida": { "type": "number" }, "comissao_liberada": { "type": "number" }, "comissao_pendente": { "type": "integer" }, "comissao_legado": { "type": "boolean" }, "comissao_porcentagem": { "type": "integer" }, "comissao_bruta": { "type": "number" }, "comissao_liquida": { "type": "number" }, "usuarios": { "type": "object", "properties": { "id": { "type": "string" }, "comissao": { "type": "integer" } } } } } }, "totais": { "type": "object", "properties": { "total": { "type": "integer" }, "comissao": { "type": "integer" }, "comissao_bruta": { "type": "integer" }, "comissao_liquida": { "type": "integer" }, "comissao_devida": { "type": "integer" }, "comissao_liberada": { "type": "integer" }, "comissao_pendente": { "type": "integer" }, "quantidade_vendas": { "type": "integer" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da venda", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "total_vendido": 2855, "total_comissoes": 18022.8199999999997089616954326629638671875, "total_comissoes_brutas": 25222.75999999999839928932487964630126953125, "total_comissoes_liberadas": 18022.8199999999997089616954326629638671875, "total_comissoes_pendentes": 0, "quantidade_vendedores": 2, "quantidade_vendas": 19, "liberacao": { "liberada": { "valor": 18022.8199999999997089616954326629638671875, "proporcao": 100 }, "pendente": { "valor": 0, "proporcao": 0 }, "devido": 18022.8199999999997089616954326629638671875 } }, "itens": [ { "id": "130854", "nome": "USUÁRIO", "vendas": [ { "id": "7061", "codigo": "10", "nome_loja": "11", "hash": "7jw4", "data": "2026-09-25", "previsao_entrega": "2026-09-25", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": null, "valor_produtos": 15, "valor_servicos": 0, "valor_total": 15, "cliente_id": null, "nome_cliente": "Consumidor", "vendedor_id": "130854", "tecnico_id": null, "usuario_id": "130854", "tipo": "PV", "data_confirmacao": "2026-09-25", "cor_situacao": "#5cb85c", "valor_total_calculado": 15, "valor_media_calculado": 1.5, "nome_vendedor": "USUÁRIO", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 1.5, "comissao_liberada": 1.5, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 10, "comissao_bruta": 1.5, "comissao_liquida": 1.5, "usuarios": { "id": "130854", "comissao": 10 } }, { "id": "7060", "codigo": "9", "nome_loja": "11", "hash": "QWRA", "data": "2026-09-24", "previsao_entrega": "2026-09-24", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 15, "valor_servicos": 200, "valor_total": 215, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "130854", "tecnico_id": null, "usuario_id": "130854", "tipo": "PP", "data_confirmacao": "2026-09-24", "cor_situacao": "#5cb85c", "valor_total_calculado": 215, "valor_media_calculado": 21.5, "nome_vendedor": "USUÁRIO", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 21.5, "comissao_liberada": 21.5, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 10, "comissao_bruta": 21.5, "comissao_liquida": 21.5, "usuarios": { "id": "130854", "comissao": 10 } } ], "totais": { "total": 230, "comissao": 23, "comissao_bruta": 23, "comissao_liquida": 23, "comissao_devida": 23, "comissao_liberada": 23, "comissao_pendente": 0, "quantidade_vendas": 2 } }, { "id": "45", "nome": "JOÃO DO BD COMPARTILHADO!", "vendas": [ { "id": "7116", "codigo": "173", "nome_loja": "Master", "hash": "QWLb", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7115", "codigo": "28978004", "nome_loja": "Master", "hash": "9y74", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 300, "valor_total": 300, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 300, "valor_media_calculado": 3000, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 2999.96999999999979991116560995578765869140625, "comissao_liquida": 2999.96999999999979991116560995578765869140625, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7112", "codigo": "28978003", "nome_loja": "Master", "hash": "LPwd", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 0, "valor_total": 21, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PP", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 21, "valor_media_calculado": 210, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 0, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7111", "codigo": "172", "nome_loja": "Master", "hash": "kBVA", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7110", "codigo": "28978002", "nome_loja": "Master", "hash": "GANa", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 300, "valor_total": 300, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 300, "valor_media_calculado": 3000, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 2999.96999999999979991116560995578765869140625, "comissao_liquida": 2999.96999999999979991116560995578765869140625, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7107", "codigo": "28978001", "nome_loja": "Master", "hash": "wPge", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 0, "valor_total": 21, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PP", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 21, "valor_media_calculado": 210, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 0, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7106", "codigo": "171", "nome_loja": "Master", "hash": "2rGm", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7105", "codigo": "28978000", "nome_loja": "Master", "hash": "RW6O", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 300, "valor_total": 300, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 300, "valor_media_calculado": 3000, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 2999.96999999999979991116560995578765869140625, "comissao_liquida": 2999.96999999999979991116560995578765869140625, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7102", "codigo": "28977999", "nome_loja": "Master", "hash": "N0Vy", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 0, "valor_total": 21, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PP", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 21, "valor_media_calculado": 210, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 0, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7101", "codigo": "170", "nome_loja": "Master", "hash": "z3AX", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7100", "codigo": "28977998", "nome_loja": "Master", "hash": "d0NO", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 300, "valor_total": 300, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 300, "valor_media_calculado": 3000, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 2999.96999999999979991116560995578765869140625, "comissao_liquida": 2999.96999999999979991116560995578765869140625, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7097", "codigo": "28977997", "nome_loja": "Master", "hash": "Vw7x", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 0, "valor_total": 21, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PP", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 21, "valor_media_calculado": 210, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 0, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7096", "codigo": "169", "nome_loja": "Master", "hash": "XxKN", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7095", "codigo": "28977996", "nome_loja": "Master", "hash": "wPgb", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 300, "valor_total": 300, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 300, "valor_media_calculado": 3000, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 2999.96999999999979991116560995578765869140625, "comissao_liquida": 2999.96999999999979991116560995578765869140625, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7092", "codigo": "28977995", "nome_loja": "Master", "hash": "j0XG", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 0, "valor_total": 21, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PP", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 21, "valor_media_calculado": 210, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 0, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7091", "codigo": "168", "nome_loja": "Master", "hash": "pzqQ", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7090", "codigo": "28977994", "nome_loja": "Master", "hash": "N0VL", "data": "2026-09-28", "previsao_entrega": "-----", "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 300, "valor_total": 300, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "PS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 300, "valor_media_calculado": 3000, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 2999.96999999999979991116560995578765869140625, "comissao_liquida": 2999.96999999999979991116560995578765869140625, "usuarios": { "id": "45", "comissao": 1000 } } ], "totais": { "total": 2625, "comissao": 26250, "comissao_bruta": 25199.76000000000931322574615478515625, "comissao_liquida": 17999.8199999999997089616954326629638671875, "comissao_devida": 17999.8199999999997089616954326629638671875, "comissao_liberada": 17999.8199999999997089616954326629638671875, "comissao_pendente": 0, "quantidade_vendas": 17 } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_comissao_vendedores", "x-periodo": { "data": "a data da venda", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "entrega_inicio", "fim": "entrega_fim", "data": "a previsão de entrega da venda", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Responda por vendedor 'vendeu R$ X, comissão R$ Y' com totais.total e totais.comissao_devida de cada item, e o total da equipe com data.totais (total_vendido e total_comissoes). A base é a data da VENDA, não o recebimento: a comissão do Financeiro é outro relatório — diga qual base usou. Entram vendas, balcão e O.S. juntos. total_comissoes é o devido (já sem comissão cancelada e devolução); total_comissoes_brutas é a porcentagem sobre o valor cheio. data.totais.liberacao (liberada/pendente/devido) responde 'o que já pode ser pago' — é outra leitura, não troque uma pela outra. Comissão 0 é normal: vendedor sem porcentagem. data.itens é uma página de VENDEDORES (cada um com a lista de vendas): nunca some as páginas como se fossem o total. entrega_inicio/entrega_fim filtram a PREVISÃO DE ENTREGA da venda e se somam ao período da venda (data_inicio/data_fim, que tem padrão mês atual): só entram vendas feitas no período E com entrega prevista no intervalo; venda sem previsão de entrega fica de fora. Para \"o que tenho para entregar\" amplie data_inicio/data_fim (até 12 meses) para alcançar vendas antigas. Devolução não tem entrega: com exibir_devolucoes=1, o intervalo de entrega passa a filtrar a data da devolução (regra da tela). situacao_id e vendedor_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Comissão dos vendedores sobre as vendas do período (data da venda, não do recebimento): por vendedor, o valor vendido e a comissão devida, liberada e pendente, com as vendas de cada um e os totais da equipe. É a mesma regra do relatório de comissão de vendedores da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `entrega_inicio` e `entrega_fim` (AAAA-MM-DD, juntos) filtram a previsão de entrega da venda. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_comissao_vendedores` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/comissao_vendedores_os": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de comissão de vendedores de O.S.", "operationId": "pedidos_relatorio_comissao_vendedores_os_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_comissao_vendedores_os", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S.)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "saida_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de saída da O.S. (com saida_fim); filtra junto com o período de entrada", "schema": { "type": "string" } }, { "name": "saida_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de saída", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da O.S. (ids em /situacoes_ordens_servicos); sem ele entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — O.S. de um cliente", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores (com um só, a resposta fica bem menor) — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "tipo_comissao", "in": "query", "required": false, "description": "P = comissiona só o valor de produtos (peças), S = só o de serviços, PS = os dois (padrão)", "schema": { "type": "string" } }, { "name": "comissao_regra", "in": "query", "required": false, "description": "regra de liberação gravada na O.S.: F = integral ao gerar o financeiro, P = integral na 1ª parcela, U = integral na última, R = parcial conforme o recebimento. O.S. sem esse registro fica de fora", "schema": { "type": "string" } }, { "name": "comissao_status", "in": "query", "required": false, "description": "pendente, parcial, liberada ou cancelado — situação da liberação da comissão. O.S. sem esse registro fica de fora", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "total_vendido": { "type": "integer" }, "total_comissoes": { "type": "integer" }, "total_comissoes_liberadas": { "type": "integer" }, "total_comissoes_pendentes": { "type": "integer" }, "quantidade_vendedores": { "type": "integer" }, "quantidade_vendas": { "type": "integer" }, "total_comissoes_brutas": { "type": "number" }, "liberacao": { "type": "object", "properties": { "liberada": { "type": "object", "properties": { "valor": { "type": "integer" }, "proporcao": { "type": "integer" } } }, "pendente": { "type": "object", "properties": { "valor": { "type": "integer" }, "proporcao": { "type": "integer" } } }, "devido": { "type": "integer" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "vendas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome_loja": { "type": "string" }, "hash": { "type": "string" }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_frete": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_total": { "type": "integer" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "tecnico_id": { "type": "string" }, "usuario_id": { "type": "string" }, "tipo": { "type": "string" }, "data_confirmacao": { "type": "string" }, "cor_situacao": { "type": "string" }, "valor_total_calculado": { "type": "integer" }, "valor_media_calculado": { "type": "integer" }, "nome_vendedor": { "type": "string" }, "comissao_regra": { "type": "string" }, "comissao_status": { "type": "string" }, "comissao_status_chave": { "type": "string" }, "comissao_devida": { "type": "integer" }, "comissao_liberada": { "type": "integer" }, "comissao_pendente": { "type": "integer" }, "comissao_legado": { "type": "boolean" }, "comissao_porcentagem": { "type": "number" }, "comissao_bruta": { "type": "number" }, "comissao_liquida": { "type": "integer" }, "comissao": { "type": "integer" }, "usuarios": { "type": "object", "properties": { "id": { "type": "string" }, "comissao": { "type": "integer" } } } } } }, "totais": { "type": "object", "properties": { "total": { "type": "integer" }, "comissao": { "type": "integer" }, "comissao_bruta": { "type": "number" }, "comissao_liquida": { "type": "integer" }, "comissao_devida": { "type": "integer" }, "comissao_liberada": { "type": "integer" }, "comissao_pendente": { "type": "integer" }, "quantidade_vendas": { "type": "integer" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de entrada da O.S.", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "total_vendido": 720, "total_comissoes": 0, "total_comissoes_liberadas": 0, "total_comissoes_pendentes": 0, "quantidade_vendedores": 1, "quantidade_vendas": 6, "total_comissoes_brutas": 7199.9399999999995998223312199115753173828125, "liberacao": { "liberada": { "valor": 0, "proporcao": 0 }, "pendente": { "valor": 0, "proporcao": 0 }, "devido": 0 } }, "itens": [ { "id": "45", "nome": "JOÃO DO BD COMPARTILHADO!", "vendas": [ { "id": "7116", "codigo": "173", "nome_loja": "Master", "hash": "QWLb", "data": "2026-09-28", "previsao_entrega": null, "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": "45", "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "comissao": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7111", "codigo": "172", "nome_loja": "Master", "hash": "kBVA", "data": "2026-09-28", "previsao_entrega": null, "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "comissao": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7106", "codigo": "171", "nome_loja": "Master", "hash": "2rGm", "data": "2026-09-28", "previsao_entrega": null, "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "comissao": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7101", "codigo": "170", "nome_loja": "Master", "hash": "z3AX", "data": "2026-09-28", "previsao_entrega": null, "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "comissao": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7096", "codigo": "169", "nome_loja": "Master", "hash": "XxKN", "data": "2026-09-28", "previsao_entrega": null, "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "comissao": 0, "usuarios": { "id": "45", "comissao": 1000 } }, { "id": "7091", "codigo": "168", "nome_loja": "Master", "hash": "pzqQ", "data": "2026-09-28", "previsao_entrega": null, "situacao_id": "3287860", "nome_situacao": "Confirmado", "valor_frete": 0, "valor_produtos": 0, "valor_servicos": 120, "valor_total": 120, "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "vendedor_id": "45", "tecnico_id": null, "usuario_id": "45", "tipo": "OS", "data_confirmacao": "2026-09-28", "cor_situacao": "#5cb85c", "valor_total_calculado": 120, "valor_media_calculado": 1200, "nome_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_regra": "Integral ao gerar financeiro", "comissao_status": "Totalmente liberada", "comissao_status_chave": "liberada", "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "comissao_legado": false, "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "comissao_bruta": 1199.990000000000009094947017729282379150390625, "comissao_liquida": 0, "comissao": 0, "usuarios": { "id": "45", "comissao": 1000 } } ], "totais": { "total": 720, "comissao": 7200, "comissao_bruta": 7199.9399999999995998223312199115753173828125, "comissao_liquida": 0, "comissao_devida": 0, "comissao_liberada": 0, "comissao_pendente": 0, "quantidade_vendas": 6 } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Ordens/RelatoriosOrdensServicos/relatorio_comissao_vendedores", "x-periodo": { "data": "a data de entrada da O.S.", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "saida_inicio", "fim": "saida_fim", "data": "a data de saída da O.S. (previsão de saída)", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Só O.S. — para vendas, balcão e O.S. juntos use /relatorios/comissao_vendedores (outra permissão). Responda por vendedor 'vendeu R$ X, comissão R$ Y' com totais.total e totais.comissao_devida de cada item, e o total com data.totais (total_vendido e total_comissoes). A base é a data de ENTRADA da O.S., não o recebimento. total_comissoes é o devido (já sem comissão cancelada); total_comissoes_brutas é a porcentagem sobre o valor cheio. data.totais.liberacao (liberada/pendente/devido) responde 'o que já pode ser pago'. data.itens é uma página de VENDEDORES (cada um com suas O.S.). saida_inicio/saida_fim filtram a DATA DE SAÍDA da O.S. (a \"Data de saída\" da tela) e se somam ao período de entrada (data_inicio/data_fim, que tem padrão mês atual): só entram O.S. abertas no período E com saída no intervalo; O.S. sem data de saída fica de fora. Para O.S. antigas com saída agora, amplie data_inicio/data_fim (até 12 meses). situacao_id e vendedor_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Comissão dos vendedores só nas ordens de serviço do período, agrupada por vendedor: para cada um, as O.S. com valor, comissão e situação da liberação, e os totais dele. É a mesma regra do relatório de comissão de vendedores da tela de relatórios de O.S.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S.. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `saida_inicio` e `saida_fim` (AAAA-MM-DD, juntos) filtram a data de saída da O.S. (previsão de saída). Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Ordens/RelatoriosOrdensServicos/relatorio_comissao_vendedores` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/curva_abc_clientes": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar curva ABC de clientes", "operationId": "pedidos_relatorio_curva_abc_clientes_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_curva_abc_clientes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período; só o mês e o ano contam (o dia é ignorado)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período; só o mês e o ano contam (o mês de data_fim entra inteiro)", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "tipos de pedido: PP = venda de produtos, PS = venda de serviços, PV = venda balcão (PDV), OS = ordem de serviço; sem ele entram os quatro — aceita vários: `tipo=1,2` ou `tipo[]=1&tipo[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do pedido (ids em /situacoes_vendas e /situacoes_ordens_servicos); sem ele entram todas as situações, inclusive as que a empresa marcou para não aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "classe", "in": "query", "required": false, "description": "curvas a mostrar na lista: A, B e/ou C (os totais continuam os do período inteiro) — aceita vários: `classe=1,2` ou `classe[]=1&classe[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — mostra só este cliente, com a classificação dele na curva de todos os clientes (os totais continuam os do período inteiro)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "quantidade_total": { "type": "integer" }, "curva_a": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "percentual": { "type": "integer" }, "quantidade": { "type": "integer" } } }, "curva_b": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "percentual": { "type": "integer" }, "quantidade": { "type": "integer" } } }, "curva_c": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "percentual": { "type": "integer" }, "quantidade": { "type": "integer" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_unitario": { "type": "number" }, "valor_total": { "type": "integer" }, "valor_acumulado": { "type": "integer" }, "percentual": { "type": "integer" }, "percentual_acumulado": { "type": "integer" }, "classificacao": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "o mês da venda (meses inteiros, do mês de data_inicio ao de data_fim)", "inicio": "2026-06-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 5, "total_paginas": 1, "cache": true }, "data": { "totais": { "itens": 1, "valor_total": 3658, "quantidade_total": 35, "curva_a": { "itens": 0, "valor_total": 0, "percentual": 0, "quantidade": 0 }, "curva_b": { "itens": 0, "valor_total": 0, "percentual": 0, "quantidade": 0 }, "curva_c": { "itens": 1, "valor_total": 3658, "percentual": 100, "quantidade": 35 } }, "itens": [ { "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "quantidade": 35, "valor_unitario": 104.5100000000000051159076974727213382720947265625, "valor_total": 3658, "valor_acumulado": 3658, "percentual": 100, "percentual_acumulado": 100, "classificacao": "C" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosCurvasAbc/relatorio_cliente", "x-periodo": { "data": "o mês da venda (Pedido.data_ano/data_mes) — meses inteiros, do mês de data_inicio ao mês de data_fim", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Curva ABC por valor: os itens são ordenados pelo valor líquido vendido (valor do item menos o rateio do desconto do pedido; frete fora) e classificados pelo percentual acumulado — A até 80%, B acima de 80% até 95%, C o restante. Atenção: o item entra na curva já somando a própria fatia, então o primeiro item que sozinho passa de 80% do valor sai B ou C (com um item só ele é C). Soma produtos e serviços dos pedidos do cliente; venda sem cliente não entra. quantidade é a soma das quantidades dos itens (não o número de pedidos — para pedidos por cliente use /relatorios/clientes_mais_compram) e valor_unitario é o valor médio por unidade de item. Devoluções não são descontadas e, sem situacao_id, entram todas as situações, inclusive canceladas. O período é mensal (meses inteiros, teto de 12 meses do calendário). totais.curva_a/b/c traz itens (quantos clientes), valor_total, percentual e quantidade; os totais são do período inteiro, mesmo com classe ou cliente_id. data.itens é só uma página, do maior para o menor valor — nunca some as linhas.", "description": "Clientes que compraram no período classificados em curva A, B e C pelo valor comprado, com quantidade de itens, valor, participação e percentual acumulado de cada um e os totais de cada curva. É a mesma regra da tela Vendas > Relatórios > Curva ABC de clientes.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram o mês da venda (Pedido.data_ano/data_mes) — meses inteiros, do mês de data_inicio ao mês de data_fim. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosCurvasAbc/relatorio_cliente` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/curva_abc_produtos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar curva ABC de produtos", "operationId": "pedidos_relatorio_curva_abc_produtos_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_curva_abc_produtos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período; só o mês e o ano contam (o dia é ignorado)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período; só o mês e o ano contam (o mês de data_fim entra inteiro)", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "tipos de pedido: PP = venda de produtos, PS = venda de serviços, PV = venda balcão (PDV), OS = ordem de serviço; sem ele entram os quatro — aceita vários: `tipo=1,2` ou `tipo[]=1&tipo[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do pedido (ids em /situacoes_vendas e /situacoes_ordens_servicos); sem ele entram todas as situações, inclusive as que a empresa marcou para não aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "classe", "in": "query", "required": false, "description": "curvas a mostrar na lista: A, B e/ou C (os totais continuam os do período inteiro) — aceita vários: `classe=1,2` ou `classe[]=1&classe[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "quantidade_total": { "type": "integer" }, "curva_a": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "percentual": { "type": "integer" }, "quantidade": { "type": "integer" } } }, "curva_b": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "percentual": { "type": "integer" }, "quantidade": { "type": "integer" } } }, "curva_c": { "type": "object", "properties": { "itens": { "type": "integer" }, "valor_total": { "type": "integer" }, "percentual": { "type": "integer" }, "quantidade": { "type": "integer" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_unitario": { "type": "number" }, "valor_total": { "type": "integer" }, "valor_acumulado": { "type": "integer" }, "percentual": { "type": "integer" }, "percentual_acumulado": { "type": "integer" }, "classificacao": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "o mês da venda (meses inteiros, do mês de data_inicio ao de data_fim)", "inicio": "2026-06-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 5, "total_paginas": 1, "cache": true }, "data": { "totais": { "itens": 1, "valor_total": 213, "quantidade_total": 19, "curva_a": { "itens": 0, "valor_total": 0, "percentual": 0, "quantidade": 0 }, "curva_b": { "itens": 0, "valor_total": 0, "percentual": 0, "quantidade": 0 }, "curva_c": { "itens": 1, "valor_total": 213, "percentual": 100, "quantidade": 19 } }, "itens": [ { "produto_id": "31998", "nome_produto": "Coca cola", "quantidade": 19, "valor_unitario": 11.21000000000000085265128291212022304534912109375, "valor_total": 213, "valor_acumulado": 213, "percentual": 100, "percentual_acumulado": 100, "classificacao": "C" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosCurvasAbc/relatorio_produto", "x-periodo": { "data": "o mês da venda (Pedido.data_ano/data_mes) — meses inteiros, do mês de data_inicio ao mês de data_fim", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Curva ABC por valor: os itens são ordenados pelo valor líquido vendido (valor do item menos o rateio do desconto do pedido; frete fora) e classificados pelo percentual acumulado — A até 80%, B acima de 80% até 95%, C o restante. Atenção: o item entra na curva já somando a própria fatia, então o primeiro item que sozinho passa de 80% do valor sai B ou C (com um item só ele é C). Só itens de produto (serviço não entra). Devoluções não são descontadas e não há filtro de situação por padrão: sem situacao_id entram todas, inclusive canceladas — para a curva do que foi efetivamente vendido, filtre as situações. O período é mensal: 2026-09-15 a 2026-10-10 soma setembro e outubro inteiros, e o teto é 12 meses do calendário (13 meses → 400). totais.curva_a/b/c traz itens (quantos produtos), valor_total, percentual (do valor) e quantidade; totais.itens e totais.valor_total são do período inteiro, mesmo com classe. data.itens é só uma página, já ordenada do maior para o menor valor — nunca some as linhas. valor_unitario é o valor médio por unidade no período.", "description": "Produtos vendidos no período classificados em curva A, B e C pelo valor vendido, com quantidade, valor, participação e percentual acumulado de cada um e os totais de cada curva. É a mesma regra da tela Vendas > Relatórios > Curva ABC de produtos.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram o mês da venda (Pedido.data_ano/data_mes) — meses inteiros, do mês de data_inicio ao mês de data_fim. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosCurvasAbc/relatorio_produto` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/devolucoes": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de devoluções", "operationId": "pedidos_relatorio_devolucoes_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_devolucoes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da devolução)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da VENDA de origem (ids em /situacoes_vendas) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — devoluções de um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — devoluções que têm este produto", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores da venda de origem — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda da venda de origem — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "formas_pagamentos": { "type": "object", "properties": [] }, "media": { "type": "integer" }, "qtd_vendas": { "type": "integer" }, "qtd_devolucoes": { "type": "integer" }, "desconto": { "type": "integer" }, "frete": { "type": "integer" }, "custo": { "type": "integer" }, "total": { "type": "integer" }, "lucro_valor": { "type": "integer" }, "lucro_porcentagem": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da devolução", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": false }, "data": { "totais": { "formas_pagamentos": [], "media": 0, "qtd_vendas": 0, "qtd_devolucoes": 0, "desconto": 0, "frete": 0, "custo": 0, "total": 0, "lucro_valor": 0, "lucro_porcentagem": 100 }, "itens": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_devolucoes", "x-periodo": { "data": "a data da devolução", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda quantidade e valor juntos: totais.qtd_devolucoes e totais.total (ticket médio em totais.media). total soma as PARCELAS das devoluções: devolução sem parcela conta na quantidade e soma 0 — quantidade alta com valor baixo é normal. Devolução é estorno: nunca some com venda nem cite lucro_valor/lucro_porcentagem (não se aplicam aqui). O relatório não registra o motivo da devolução; para quais itens voltaram não há quebra por produto aqui. data.itens é só uma página — nunca some as linhas. custo só vem com a permissão de ver custo. situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Devoluções do período já somadas — quantidade, valor, ticket médio, desconto, frete e o total por forma de pagamento — e a lista das devoluções. É a mesma regra do relatório de devoluções da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da devolução. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_devolucoes` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/equipamentos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de equipamentos de O.S.", "operationId": "pedidos_relatorio_equipamentos_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_equipamentos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S.)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "saida_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de saída da O.S. (com saida_fim); filtra junto com o período de entrada", "schema": { "type": "string" } }, { "name": "saida_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de saída", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da O.S. (ids em /situacoes_ordens_servicos); sem ele entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — O.S. de um cliente", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "tecnico_id", "in": "query", "required": false, "description": "int — um técnico (principal ou vinculado à O.S.)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "equipamento", "in": "query", "required": false, "description": "string — nome do equipamento (em oficina, o veículo) — busca parcial", "schema": { "type": "string" } }, { "name": "marca", "in": "query", "required": false, "description": "string — marca do equipamento (busca parcial)", "schema": { "type": "string" } }, { "name": "modelo", "in": "query", "required": false, "description": "string — modelo do equipamento (busca parcial)", "schema": { "type": "string" } }, { "name": "serie", "in": "query", "required": false, "description": "string — número de série (em oficina, a placa) — busca parcial", "schema": { "type": "string" } }, { "name": "campo_extra_1", "in": "query", "required": false, "description": "string — 1º campo extra do equipamento, valor exato (em oficina, o ano)", "schema": { "type": "string" } }, { "name": "campo_extra_2", "in": "query", "required": false, "description": "string — 2º campo extra do equipamento, valor exato (em oficina, a cor)", "schema": { "type": "string" } }, { "name": "campo_extra_3", "in": "query", "required": false, "description": "string — 3º campo extra do equipamento, valor exato (em oficina, a quilometragem)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "total_pecas": { "type": "integer" }, "total_servicos": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "nome_situacao": { "type": "string" }, "nome_cliente": { "type": "string" }, "nome_vendedor": { "type": "string" }, "valor_total": { "type": "integer" }, "equipamento": { "type": "object", "properties": { "id": { "type": "string" }, "pedido_id": { "type": "string" }, "equipamento": { "type": "string" }, "serie": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "condicoes": { "type": "string" }, "defeitos": { "type": "string" }, "acessorios": { "type": "string" }, "solucao": { "type": "string" }, "laudo": { "type": "string" }, "termos_garantia": { "type": "string" }, "hash": { "type": "string" }, "campo_extra_1": { "type": "string" }, "campo_extra_2": { "type": "string" }, "campo_extra_3": { "type": "string" } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "pedido_id": { "type": "string" }, "produto_id": { "type": "string" }, "estoque_id": { "type": "string" }, "tipo": { "type": "string" }, "movimentacao": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "possui_variacao": { "type": "string" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "tipo_valor_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": "integer" }, "valor_venda": { "type": "integer" }, "altura": { "type": "string" }, "largura": { "type": "string" }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_total": { "type": "integer" }, "hash_equipamento": { "type": "string" }, "lancado": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "nome_completo": { "type": "string" } } } }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "pedido_id": { "type": "string" }, "situacao": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "cor": { "type": "string" } } } }, "atributos": { "type": "object", "properties": [] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de entrada da O.S.", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 6, "pagina": 1, "limite": 2, "total_paginas": 3, "cache": false }, "data": { "totais": { "quantidade": 6, "total_pecas": 0, "total_servicos": 720 }, "itens": [ { "id": "7116", "codigo": "173", "nome_loja": "Master", "data": "2026-09-28", "previsao_entrega": null, "nome_situacao": "Confirmado", "nome_cliente": "Cliente TESTE SR", "nome_vendedor": "João do BD COMPARTILHADO!", "valor_total": 120, "equipamento": { "id": "523", "pedido_id": "7116", "equipamento": "Notebook", "serie": "SNc6dae1", "marca": "Marca X", "modelo": "Y", "condicoes": "", "defeitos": "", "acessorios": "", "solucao": "", "laudo": "", "termos_garantia": "", "hash": "1c7e4b250bb34f3326b82b4cbbdd17549a3def27", "campo_extra_1": "", "campo_extra_2": "", "campo_extra_3": "" }, "produtos": [ { "id": "213321128", "pedido_id": "7116", "produto_id": "31999", "estoque_id": "", "tipo": "S", "movimentacao": "S", "nome_produto": "Hospedagem de sites", "detalhes": "", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "", "quantidade": 1, "tipo_valor_id": "", "nome_tipo_valor": "", "valor_custo": 100, "valor_venda": 120, "altura": "", "largura": "", "tipo_desconto": "R$", "desconto_valor": 0, "desconto_porcentagem": 0, "valor_total": 120, "hash_equipamento": "", "lancado": "0", "cadastrado_em": "2026-09-28 19:59:53", "modificado_em": "2026-09-28 19:59:53", "nome_completo": "Hospedagem de sites" } ], "situacoes": [ { "id": "7117", "pedido_id": "7116", "situacao": "0", "situacao_id": "3287860", "nome_situacao": "Confirmado", "data": "2026-09-28", "observacao": "Ordem de serviço cadastrada", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-09-28 19:59:53", "cor": "#5cb85c" } ], "atributos": [] }, { "id": "7111", "codigo": "172", "nome_loja": "Master", "data": "2026-09-28", "previsao_entrega": null, "nome_situacao": "Confirmado", "nome_cliente": "Cliente TESTE SR", "nome_vendedor": "João do BD COMPARTILHADO!", "valor_total": 120, "equipamento": { "id": "522", "pedido_id": "7111", "equipamento": "Notebook", "serie": "SNed5fbb", "marca": "Marca X", "modelo": "Y", "condicoes": "", "defeitos": "", "acessorios": "", "solucao": "", "laudo": "", "termos_garantia": "", "hash": "21dfdba3ea8caa1938f9e3ca1813b292d6e49c43", "campo_extra_1": "", "campo_extra_2": "", "campo_extra_3": "" }, "produtos": [ { "id": "213321123", "pedido_id": "7111", "produto_id": "31999", "estoque_id": "", "tipo": "S", "movimentacao": "S", "nome_produto": "Hospedagem de sites", "detalhes": "", "movimenta_estoque": "1", "possui_variacao": "0", "sigla_unidade": "", "quantidade": 1, "tipo_valor_id": "", "nome_tipo_valor": "", "valor_custo": 100, "valor_venda": 120, "altura": "", "largura": "", "tipo_desconto": "R$", "desconto_valor": 0, "desconto_porcentagem": 0, "valor_total": 120, "hash_equipamento": "", "lancado": "0", "cadastrado_em": "2026-09-28 19:59:34", "modificado_em": "2026-09-28 19:59:34", "nome_completo": "Hospedagem de sites" } ], "situacoes": [ { "id": "7112", "pedido_id": "7111", "situacao": "0", "situacao_id": "3287860", "nome_situacao": "Confirmado", "data": "2026-09-28", "observacao": "Ordem de serviço cadastrada", "usuario_id": "45", "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-09-28 19:59:34", "cor": "#5cb85c" } ], "atributos": [] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Ordens/RelatoriosOrdensServicos/relatorio_equipamentos", "x-periodo": { "data": "a data de entrada da O.S.", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "saida_inicio", "fim": "saida_fim", "data": "a data de saída da O.S. (previsão de saída)", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Cada item é uma O.S. com UM equipamento (equipamento: null quando a O.S. não tem): O.S. com dois equipamentos aparece em duas linhas, então não conte linhas como O.S. — use data.totais.quantidade (O.S. distintas), total_pecas (produtos) e total_servicos, que contam cada O.S. uma vez. valor_total é o da O.S. inteira, repetido em cada linha dela. situacoes é o histórico da O.S., do mais recente para o mais antigo. campo_extra_1/2/3 são ano, cor e quilometragem em oficina mecânica. O valor_custo dos itens só vem com a permissão de ver custo. data.itens é só uma página. saida_inicio/saida_fim filtram a DATA DE SAÍDA da O.S. (a \"Data de saída\" da tela) e se somam ao período de entrada (data_inicio/data_fim, que tem padrão mês atual): só entram O.S. abertas no período E com saída no intervalo; O.S. sem data de saída fica de fora. Para O.S. antigas com saída agora, amplie data_inicio/data_fim (até 12 meses). situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Equipamentos (em oficina, veículos) das ordens de serviço do período: uma linha por O.S. e equipamento, com os itens, o histórico de situações e o valor da O.S. Os totais contam as O.S. e somam peças e serviços. É a mesma regra do relatório de equipamentos da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S.. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `saida_inicio` e `saida_fim` (AAAA-MM-DD, juntos) filtram a data de saída da O.S. (previsão de saída). Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Ordens/RelatoriosOrdensServicos/relatorio_equipamentos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/orcamentos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de orçamentos", "operationId": "pedidos_relatorio_orcamentos_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_orcamentos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data do orçamento)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do orçamento (ids em /situacoes_orcamentos; o nome varia por empresa) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — orçamentos de um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — orçamentos que têm este produto", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valorTotal": { "type": "integer" }, "media": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data do orçamento", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": false }, "data": { "totais": { "quantidade": 0, "valorTotal": 0, "media": 0 }, "itens": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Orcamentos/RelatoriosOrcamentos/relatorio_orcamentos", "x-periodo": { "data": "a data do orçamento", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda quantidade e valor juntos: totais.quantidade e totais.valorTotal (ticket médio em totais.media). Orçamento é proposta, não receita: nunca some com venda nem chame de faturado. Sem situacao_id o total já EXCLUI as situações ocultas na listagem (ex.: cancelado). Os totais não têm quebra por situação: para conversão consulte uma situação por vez (ids em /situacoes_orcamentos) e não chute qual significa 'aprovado'. Usuário sem a permissão de ver orçamentos de outros só vê os que vendeu ou cadastrou. data.itens é só uma página — nunca some as linhas. situacao_id e vendedor_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Orçamentos (de produto e de serviço) do período já somados — quantidade, valor total e ticket médio — e a lista dos orçamentos. É a mesma regra do relatório de orçamentos da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do orçamento. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Orcamentos/RelatoriosOrcamentos/relatorio_orcamentos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/ordens_servicos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de ordens de serviço", "operationId": "pedidos_relatorio_ordens_servicos_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_ordens_servicos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S.)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "saida_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de saída da O.S. (com saida_fim); filtra junto com o período de entrada", "schema": { "type": "string" } }, { "name": "saida_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de saída", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da O.S. (ids em /situacoes_ordens_servicos); sem ele entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — O.S. de um cliente", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "tecnico_id", "in": "query", "required": false, "description": "int — um técnico (principal ou vinculado à O.S.)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "só O.S. com parcela numa destas formas de pagamento (os totais por forma passam a ter só elas) — ids em `/formas_pagamentos` — aceita vários: `forma_pagamento_id=1,2` ou `forma_pagamento_id[]=1&forma_pagamento_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "equipamento", "in": "query", "required": false, "description": "string — nome do equipamento (em oficina, o veículo) — busca parcial", "schema": { "type": "string" } }, { "name": "marca", "in": "query", "required": false, "description": "string — marca do equipamento (busca parcial)", "schema": { "type": "string" } }, { "name": "modelo", "in": "query", "required": false, "description": "string — modelo do equipamento (busca parcial)", "schema": { "type": "string" } }, { "name": "serie", "in": "query", "required": false, "description": "string — número de série (em oficina, a placa) — busca parcial", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "string — O.S. com um item cujo nome contém o texto", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "string — O.S. com um serviço cujo nome contém o texto", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "formas_pagamentos": { "type": "object", "properties": { "Sem forma de pagamento": { "type": "integer" } } }, "media": { "type": "integer" }, "qtd_vendas": { "type": "integer" }, "qtd_devolucoes": { "type": "integer" }, "desconto": { "type": "integer" }, "frete": { "type": "integer" }, "custo": { "type": "integer" }, "total": { "type": "integer" }, "lucro_valor": { "type": "integer" }, "lucro_porcentagem": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "string" }, "horario": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_vendedor": { "type": "string" }, "nome_centro_custo": { "type": [ "string", "null" ] }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_frete": { "type": "integer" }, "nome_transportadora": { "type": [ "string", "null" ] }, "movimentacao": { "type": "string" }, "valor_total": { "type": "integer" }, "codigo": { "type": "string" }, "nome_loja": { "type": "string" }, "hash": { "type": "string" }, "previsao_entrega": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "nome_situacao": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "tipo": { "type": "string" }, "vendedor_id": { "type": "string" }, "usuario_id": { "type": "string" }, "cor_situacao": { "type": "string" }, "equipamentos": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "pedido_id": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_venda": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" } } } }, "parcelas": { "type": "array", "items": { "type": "object", "properties": { "pedido_id": { "type": "string" }, "valor": { "type": "integer" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" } } } } } } }, "atributos": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de entrada da O.S.", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 6, "pagina": 1, "limite": 2, "total_paginas": 3, "cache": false }, "data": { "totais": { "formas_pagamentos": { "Sem forma de pagamento": 720 }, "media": 120, "qtd_vendas": 6, "qtd_devolucoes": 0, "desconto": 0, "frete": 0, "custo": 600, "total": 720, "lucro_valor": 120, "lucro_porcentagem": 20 }, "itens": [ { "id": "7116", "data": "2026-09-28", "horario": null, "situacao_id": "3287860", "nome_canal_venda": "Presencial", "nome_vendedor": "João do BD COMPARTILHADO!", "nome_centro_custo": null, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_custo": 100, "valor_produtos": 0, "valor_servicos": 120, "valor_frete": 0, "nome_transportadora": null, "movimentacao": "C", "valor_total": 120, "codigo": "173", "nome_loja": "Master", "hash": "QWLb", "previsao_entrega": null, "cadastrado_em": "19:59:53", "nome_situacao": "Confirmado", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "tipo": "OS", "vendedor_id": "45", "usuario_id": "45", "cor_situacao": "#5cb85c", "equipamentos": "Notebook - Marca X - Y - SNc6dae1", "produtos": [ { "id": "213321128", "pedido_id": "7116", "quantidade": 1, "valor_custo": 100, "valor_venda": 120, "desconto_valor": 0, "desconto_porcentagem": 0 } ], "parcelas": [ { "pedido_id": "7116", "valor": 120, "forma_pagamento_id": "", "nome_forma_pagamento": "" } ] }, { "id": "7111", "data": "2026-09-28", "horario": null, "situacao_id": "3287860", "nome_canal_venda": "Presencial", "nome_vendedor": "João do BD COMPARTILHADO!", "nome_centro_custo": null, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_custo": 100, "valor_produtos": 0, "valor_servicos": 120, "valor_frete": 0, "nome_transportadora": null, "movimentacao": "C", "valor_total": 120, "codigo": "172", "nome_loja": "Master", "hash": "kBVA", "previsao_entrega": null, "cadastrado_em": "19:59:34", "nome_situacao": "Confirmado", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "tipo": "OS", "vendedor_id": "45", "usuario_id": "45", "cor_situacao": "#5cb85c", "equipamentos": "Notebook - Marca X - Y - SNed5fbb", "produtos": [ { "id": "213321123", "pedido_id": "7111", "quantidade": 1, "valor_custo": 100, "valor_venda": 120, "desconto_valor": 0, "desconto_porcentagem": 0 } ], "parcelas": [ { "pedido_id": "7111", "valor": 120, "forma_pagamento_id": "", "nome_forma_pagamento": "" } ] } ], "atributos": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Ordens/RelatoriosOrdensServicos/relatorio_ordens_servicos", "x-periodo": { "data": "a data de entrada da O.S.", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "saida_inicio", "fim": "saida_fim", "data": "a data de saída da O.S. (previsão de saída)", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: responda valor e quantidade juntos (total e qtd_vendas — aqui qtd_vendas é a quantidade de O.S.) e cite o período de meta.periodo e as lojas de meta.loja_id. A data é a de ENTRADA da O.S., não a de saída nem a do pagamento. O total é o valor das O.S. (não é faturamento fiscal nem dinheiro recebido). formas_pagamentos soma o valor das parcelas por forma. custo, lucro_valor, lucro_porcentagem e o valor_custo das O.S. e dos itens só vêm com a permissão de ver custo; lucro_porcentagem é markup sobre o custo. data.itens é só uma página — nunca some as linhas. data.atributos traz id e nome dos campos extras de O.S.; atributos_formatados de cada O.S. vem indexado por esse id. saida_inicio/saida_fim filtram a DATA DE SAÍDA da O.S. (a \"Data de saída\" da tela) e se somam ao período de entrada (data_inicio/data_fim, que tem padrão mês atual): só entram O.S. abertas no período E com saída no intervalo; O.S. sem data de saída fica de fora. Para O.S. antigas com saída agora, amplie data_inicio/data_fim (até 12 meses). situacao_id, vendedor_id, canal_venda_id e forma_pagamento_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros. Não há quebra por situação, técnico ou cliente nos totais: por situação use /ordens_servicos/kanban; para comparar técnicos, uma chamada por tecnico_id. Sem O.S. no período (qtd_vendas 0), lucro_porcentagem vem 100: ignore.", "description": "Ordens de serviço do período já somadas — total, quantidade, ticket médio, desconto, frete, custo, lucro e o total por forma de pagamento — e a lista das O.S. com itens, parcelas e equipamentos. É a mesma regra do relatório de ordens de serviço da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S.. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `saida_inicio` e `saida_fim` (AAAA-MM-DD, juntos) filtram a data de saída da O.S. (previsão de saída). Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Ordens/RelatoriosOrdensServicos/relatorio_ordens_servicos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/produtos_vendidos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de produtos vendidos", "operationId": "pedidos_relatorio_produtos_vendidos_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_produtos_vendidos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "entrega_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da previsão de entrega (com entrega_fim); filtra junto com o período da venda", "schema": { "type": "string" } }, { "name": "entrega_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da previsão de entrega", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da venda (ids em /situacoes_vendas; venda e O.S. têm ids diferentes — sem ele entram todas as situações visíveis, de venda e de O.S.) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — vendas de um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — só este produto", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendas destes vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de produto (inclui os subgrupos); SG = produtos sem grupo", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — só produtos deste fornecedor", "schema": { "type": "string" } }, { "name": "exibir_devolucoes", "in": "query", "required": false, "description": "1 = abate as devoluções do período; sem ele o total é bruto (0 ou 1)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidadeTotal": { "type": "integer" }, "valorTotal": { "type": "integer" }, "custoTotal": { "type": "integer" }, "lucroTotal": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "codigo_barra": { "type": "string" }, "localizacao": { "type": "string" }, "produto_id": { "type": "string" }, "nome": { "type": "string" }, "grupo": { "type": [ "string", "null" ] }, "valor_custo_produto": { "type": "integer" }, "quantidade": { "type": "integer" }, "desconto": { "type": "integer" }, "frete": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_venda": { "type": "number" }, "valor_total": { "type": "integer" }, "custo_medio": { "type": "integer" }, "valor_medio": { "type": "number" }, "lucro": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da venda", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidadeTotal": 12, "valorTotal": 135, "custoTotal": 120, "lucroTotal": 15 }, "itens": [ { "codigo": "2050460512009", "codigo_barra": "2000129950406", "localizacao": "------", "produto_id": "31998", "nome": "Coca cola", "grupo": null, "valor_custo_produto": 10, "quantidade": 12, "desconto": 0, "frete": 0, "valor_custo": 120, "valor_venda": 82.5, "valor_total": 135, "custo_medio": 10, "valor_medio": 11.25, "lucro": 15 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_produtos_vendidos", "x-periodo": { "data": "a data da venda", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "entrega_inicio", "fim": "entrega_fim", "data": "a previsão de entrega da venda", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: quantidadeTotal é a soma de UNIDADES de produto (não o número de vendas) e valorTotal o valor delas — responda os dois juntos e cite o período de meta.periodo. data.itens é só uma página, ordenada da maior para a menor quantidade: nunca some as linhas; para o ranking use a ordem que veio. Só entram itens de produto (serviço fica no relatório de serviços vendidos). Sem situacao_id entram vendas, balcão e O.S. em qualquer situação visível, inclusive em aberto. Devolução só é abatida com exibir_devolucoes=1. custoTotal, lucroTotal e os custos das linhas só vêm com a permissão de ver custo — se não vierem, não fale de custo nem lucro. entrega_inicio/entrega_fim filtram a PREVISÃO DE ENTREGA da venda e se somam ao período da venda (data_inicio/data_fim, que tem padrão mês atual): só entram vendas feitas no período E com entrega prevista no intervalo; venda sem previsão de entrega fica de fora. Para \"o que tenho para entregar\" amplie data_inicio/data_fim (até 12 meses) para alcançar vendas antigas. Devolução não tem entrega: com exibir_devolucoes=1, o intervalo de entrega passa a filtrar a data da devolução (regra da tela). situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Produtos vendidos no período, somados por produto (e variação): quantidade, valor total, custo e lucro, com os totais do período. É a mesma regra do relatório de produtos vendidos da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `entrega_inicio` e `entrega_fim` (AAAA-MM-DD, juntos) filtram a previsão de entrega da venda. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_produtos_vendidos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/servicos_vendidos": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de serviços vendidos", "operationId": "pedidos_relatorio_servicos_vendidos_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_servicos_vendidos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "entrega_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da previsão de entrega (com entrega_fim); filtra junto com o período da venda", "schema": { "type": "string" } }, { "name": "entrega_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da previsão de entrega", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da venda (ids em /situacoes_vendas; venda e O.S. têm ids diferentes — sem ele entram todas as situações visíveis, de venda e de O.S.) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — vendas de um cliente", "schema": { "type": "string" } }, { "name": "servico_id", "in": "query", "required": false, "description": "int — só este serviço", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendas destes vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — só serviços deste fornecedor", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "custo": { "type": "integer" }, "total": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "produto_id": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" }, "valor_custo": { "type": "integer" }, "custo_medio": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_percentual": { "type": "integer" }, "media": { "type": "number" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da venda", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 13, "custo": 1300, "total": 2720 }, "itens": [ { "codigo": "2042423891504", "nome": "Hospedagem de sites", "produto_id": "31999", "quantidade": 13, "valor_total": 2720, "valor_custo": 1300, "custo_medio": 100, "desconto_valor": 0, "desconto_percentual": 0, "media": 209.229999999999989768184605054557323455810546875 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_servicos_vendidos", "x-periodo": { "data": "a data da venda", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "entrega_inicio", "fim": "entrega_fim", "data": "a previsão de entrega da venda", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: quantidade é a soma das QUANTIDADES de serviço (não o número de vendas) e total o valor — responda os dois juntos e cite o período. data.itens é só uma página e vem ordenada por QUANTIDADE, não por valor: para 'qual serviço mais faturou' compare valor_total, sem supor que o primeiro é o de maior valor. Sem situacao_id entram vendas, balcão e O.S. em qualquer situação visível, não só as concluídas. Devolução nunca é abatida aqui. custo e os custos das linhas só vêm com a permissão de ver custo. entrega_inicio/entrega_fim filtram a PREVISÃO DE ENTREGA da venda e se somam ao período da venda (data_inicio/data_fim, que tem padrão mês atual): só entram vendas feitas no período E com entrega prevista no intervalo; venda sem previsão de entrega fica de fora. Para \"o que tenho para entregar\" amplie data_inicio/data_fim (até 12 meses) para alcançar vendas antigas. situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Serviços vendidos no período, somados por serviço: quantidade, valor total, custo, desconto e valor médio, com os totais do período. É a mesma regra do relatório de serviços vendidos da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `entrega_inicio` e `entrega_fim` (AAAA-MM-DD, juntos) filtram a previsão de entrega da venda. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_servicos_vendidos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/tempo_situacao": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de tempo por situação das O.S.", "operationId": "pedidos_relatorio_tempo_situacao_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_tempo_situacao", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de entrada da O.S., não a da troca de situação)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "saida_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de saída da O.S. (com saida_fim); filtra junto com o período de entrada", "schema": { "type": "string" } }, { "name": "saida_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de saída", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "só O.S. que estão hoje numa destas situações (ids em /situacoes_ordens_servicos); sem ele entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — O.S. de um cliente", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "tecnico_id", "in": "query", "required": false, "description": "int — um técnico (principal ou vinculado à O.S.)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — aceito, mas não filtra: o relatório de tempo por situação não olha as parcelas (a tela manda o campo e também o ignora)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "situacao_id": { "type": "integer" }, "nome": { "type": "string" }, "cor": { "type": [ "string", "null" ] }, "ate_5_dias": { "type": "integer" }, "de_6_a_10_dias": { "type": "integer" }, "de_11_a_20_dias": { "type": "integer" }, "de_21_a_30_dias": { "type": "integer" }, "acima_30_dias": { "type": "integer" }, "total": { "type": "integer" } } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "data": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "loja_id": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "entrada_situacao_em": { "type": "string" }, "dias_na_situacao": { "type": "integer" }, "faixa": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de entrada da O.S.", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 6, "pagina": 1, "limite": 2, "total_paginas": 3, "cache": false }, "data": { "totais": { "quantidade": 6, "situacoes": [ { "situacao_id": 3287860, "nome": "Confirmado", "cor": null, "ate_5_dias": 0, "de_6_a_10_dias": 0, "de_11_a_20_dias": 0, "de_21_a_30_dias": 6, "acima_30_dias": 0, "total": 6 } ] }, "itens": [ { "id": "7116", "codigo": "173", "data": "2026-09-28", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "loja_id": "65", "situacao_id": "3287860", "nome_situacao": "Confirmado", "entrada_situacao_em": "2026-09-28 19:59:53", "dias_na_situacao": 29, "faixa": "de_21_a_30_dias" }, { "id": "7111", "codigo": "172", "data": "2026-09-28", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "loja_id": "65", "situacao_id": "3287860", "nome_situacao": "Confirmado", "entrada_situacao_em": "2026-09-28 19:59:34", "dias_na_situacao": 29, "faixa": "de_21_a_30_dias" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Ordens/RelatoriosOrdensServicos/relatorio_tempo_situacao", "x-periodo": { "data": "a data de entrada da O.S.", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "saida_inicio", "fim": "saida_fim", "data": "a data de saída da O.S. (previsão de saída)", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "dias_na_situacao = dias desde a ENTRADA na situação atual (hoje menos o dia da entrada; horas não contam): reaplicar a mesma situação não zera a contagem e, se a O.S. saiu e voltou para a situação, conta só desde a volta. Não é o tempo total da O.S. nem a soma do tempo em cada situação, e o relatório não mostra por quanto tempo a O.S. ficou nas situações anteriores. O período filtra a data de entrada da O.S., não a data da troca de situação: uma O.S. aberta em junho e parada há 40 dias só aparece se junho estiver no período. O.S. sem nenhum registro no histórico de situações não entra. Para \"quantas O.S. estão paradas há mais de 30 dias\" use data.totais.situacoes[].acima_30_dias (somado por situação) — data.itens é só uma página. Cada item é uma O.S. com entrada_situacao_em (data e hora da entrada) e faixa. saida_inicio/saida_fim filtram a DATA DE SAÍDA da O.S. (a \"Data de saída\" da tela) e se somam ao período de entrada (data_inicio/data_fim, que tem padrão mês atual): só entram O.S. abertas no período E com saída no intervalo; O.S. sem data de saída fica de fora. Para O.S. antigas com saída agora, amplie data_inicio/data_fim (até 12 meses). situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros.", "description": "Há quantos dias cada ordem de serviço do período está na situação em que se encontra hoje, contado desde a entrada nessa situação. Os totais contam as O.S. por situação em cinco faixas de dias (até 5, 6 a 10, 11 a 20, 21 a 30 e acima de 30). É a mesma regra do relatório de tempo por situação da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrada da O.S.. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `saida_inicio` e `saida_fim` (AAAA-MM-DD, juntos) filtram a data de saída da O.S. (previsão de saída). Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Ordens/RelatoriosOrdensServicos/relatorio_tempo_situacao` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/vendas": { "get": { "tags": [ "Orçamentos, vendas e ordens de serviço" ], "summary": "Consultar relatório de vendas", "operationId": "pedidos_relatorio_vendas_listar", "x-modulo": "pedidos", "x-recurso": "relatorio_vendas", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da venda)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "entrega_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da previsão de entrega (com entrega_fim); filtra junto com o período da venda", "schema": { "type": "string" } }, { "name": "entrega_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da previsão de entrega", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "PP = venda de produto, PS = venda de serviço, PV = balcão/PDV, OS = ordem de serviço; sem ele entram os quatro", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações da venda (ids em /situacoes_vendas) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — nome do cliente (busca parcial)", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — vendas que têm este produto", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "string — nome do produto (busca parcial)", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "vendedores — aceita vários: `vendedor_id=1,2` ou `vendedor_id[]=1&vendedor_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "periodo2": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "situacao_id": { "type": "array", "items": { "type": "string" } } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "formas_pagamentos": { "type": "object", "properties": { "Dinheiro à Vista": { "type": "integer" } } }, "media": { "type": "integer" }, "qtd_vendas": { "type": "integer" }, "qtd_devolucoes": { "type": "integer" }, "desconto": { "type": "integer" }, "frete": { "type": "integer" }, "custo": { "type": "integer" }, "total": { "type": "integer" }, "lucro_valor": { "type": "integer" }, "lucro_porcentagem": { "type": "number" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "string" }, "horario": { "type": [ "string", "null" ] }, "situacao_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "nome_vendedor": { "type": "string" }, "nome_centro_custo": { "type": [ "string", "null" ] }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_frete": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "movimentacao": { "type": "string" }, "valor_total": { "type": "integer" }, "codigo": { "type": "string" }, "nome_loja": { "type": "string" }, "hash": { "type": "string" }, "previsao_entrega": { "type": "string" }, "cadastrado_em": { "type": "string" }, "nome_situacao": { "type": "string" }, "cliente_id": { "type": [ "string", "null" ] }, "nome_cliente": { "type": "string" }, "tipo": { "type": "string" }, "vendedor_id": { "type": "string" }, "usuario_id": { "type": "string" }, "cor_situacao": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_venda": { "type": "integer" }, "desconto_valor": { "type": [ "string", "null" ] }, "desconto_porcentagem": { "type": [ "string", "null" ] } } } }, "parcelas": { "type": "array", "items": { "type": "object", "properties": { "valor": { "type": "integer" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data da venda", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "periodo2": { "data": "a previsão de entrega da venda", "inicio": "2026-09-01", "fim": "2026-09-30" }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "situacao_id": [ "3287860" ] }, "total_registros": 2, "pagina": 1, "limite": 1, "total_paginas": 2, "cache": true }, "data": { "totais": { "formas_pagamentos": { "Dinheiro à Vista": 230 }, "media": 115, "qtd_vendas": 2, "qtd_devolucoes": 0, "desconto": 0, "frete": 0, "custo": 120, "total": 230, "lucro_valor": 110, "lucro_porcentagem": 91.6700000000000017053025658242404460906982421875 }, "itens": [ { "id": "7061", "data": "2026-09-25", "horario": null, "situacao_id": "3287860", "nome_canal_venda": "Presencial", "nome_vendedor": "Usuário", "nome_centro_custo": null, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_custo": 10, "valor_produtos": 15, "valor_servicos": 0, "valor_frete": null, "nome_transportadora": null, "movimentacao": "C", "valor_total": 15, "codigo": "10", "nome_loja": "11", "hash": "7jw4", "previsao_entrega": "2026-09-25", "cadastrado_em": "11:36:17", "nome_situacao": "Confirmado", "cliente_id": null, "nome_cliente": "Consumidor", "tipo": "PV", "vendedor_id": "130854", "usuario_id": "130854", "cor_situacao": "#5cb85c", "produtos": [ { "id": "213321073", "quantidade": 1, "valor_custo": 10, "valor_venda": 15, "desconto_valor": null, "desconto_porcentagem": null } ], "parcelas": [ { "valor": 15, "forma_pagamento_id": "646904", "nome_forma_pagamento": "Dinheiro à Vista" } ] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Vendas/RelatoriosVendas/relatorio_vendas", "x-periodo": { "data": "a data da venda", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "entrega_inicio", "fim": "entrega_fim", "data": "a previsão de entrega da venda", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: responda valor e quantidade juntos (total e qtd_vendas) e cite o período de meta.periodo e as lojas de meta.loja_id. data.itens é só uma página — nunca some as linhas. Sem tipo, qtd_vendas mistura venda de produto, de serviço, balcão e O.S. O total é de pedidos de venda (não é faturamento fiscal nem dinheiro recebido) e não desconta devoluções. formas_pagamentos soma o valor das parcelas por forma. custo, lucro_valor e lucro_porcentagem só vêm com a permissão de ver custo; lucro_porcentagem é markup sobre o custo. entrega_inicio/entrega_fim filtram a PREVISÃO DE ENTREGA da venda e se somam ao período da venda (data_inicio/data_fim, que tem padrão mês atual): só entram vendas feitas no período E com entrega prevista no intervalo; venda sem previsão de entrega fica de fora. Para \"o que tenho para entregar\" amplie data_inicio/data_fim (até 12 meses) para alcançar vendas antigas. situacao_id, vendedor_id e canal_venda_id aceitam vários ids (situacao_id=1,2; um id só continua valendo) e voltam como lista em meta.filtros. A única quebra pronta é formas_pagamentos: vendedor, cliente, produto, situação, canal e tipo são filtros — para comparar, faça uma chamada por valor. Sem venda no período (qtd_vendas 0), lucro_porcentagem vem 100: ignore.", "description": "Vendas do período já somadas — total, quantidade, ticket médio, desconto, frete, custo, lucro e o total por forma de pagamento — e a lista das vendas. É a mesma regra do relatório de vendas da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da venda. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `entrega_inicio` e `entrega_fim` (AAAA-MM-DD, juntos) filtram a previsão de entrega da venda. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `Vendas/RelatoriosVendas/relatorio_vendas` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/compras": { "get": { "tags": [ "Estoque e compras" ], "summary": "Listar compras", "operationId": "estoque_compras_listar", "x-modulo": "estoque", "x-recurso": "compras", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — emissão a partir deste dia; sem datas entra o histórico inteiro (pode mandar só uma das duas)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — emissão até este dia", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele (ou vazio) entra SÓ a loja padrão da chave (a loja vinculada à chave ou, sem ela, a matriz), não todas", "schema": { "type": "string" } }, { "name": "loja", "in": "query", "required": false, "description": "vazio (loja=) = todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número da compra (não o id); com ele o período é ignorado", "schema": { "type": "string" } }, { "name": "numero-nfe", "in": "query", "required": false, "description": "número da NF-e do fornecedor lançado na compra (exato); com ele o período é ignorado", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação da compra; sem ele ficam de fora as compras em situação configurada para não aparecer na listagem — ids em `/situacoes_compras`", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (não há busca por nome nesta listagem) — ids em `/fornecedores`", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "texto — produto da compra: uma palavra casa pelo começo de uma palavra do nome; várias palavras precisam estar inteiras", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "texto — serviço da compra, mesma regra de produto", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — última alteração da compra a partir deste dia", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — última alteração até 00:00 deste dia (para incluir o dia, mande o dia seguinte)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "fornecedor_id": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "data_emissao": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "numero_nfe": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "pagar_frete": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_impostos": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" }, "forma_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "intervalo_dias": { "type": [ "string", "null" ] }, "numero_parcelas": { "type": "string" }, "data_primeira_parcela": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "cadastrado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "id": { "type": "string" }, "situacao": { "type": "string" }, "observacao": { "type": "string" }, "funcionario": { "type": "string" }, "data": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "quantidade_saida": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_total": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" } } } } } }, "campos_extras": { "type": "object", "properties": [] } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "24", "codigo": "395", "fornecedor_id": "3", "nome_fornecedor": "BETEL TECNOLOGIA SOFTWARE LTDA", "data_emissao": "2020-01-27", "situacao_id": "13", "nome_situacao": "Em aberto", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "numero_nfe": null, "valor_frete": "0.00", "pagar_frete": "1", "transportadora_id": "1", "nome_transportadora": "Transportadora", "valor_produtos": "1.10", "valor_impostos": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "1.10", "forma_pagamento": "P", "forma_pagamento_id": "579722", "intervalo_dias": null, "numero_parcelas": "3", "data_primeira_parcela": null, "observacoes": "Valor Aprox dos Tributos: R$ 0,26", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "cadastrado_em": "2020-01-27 11:15:02", "pagamentos": [ { "pagamento": { "id": "55", "data_vencimento": "2020-01-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "id": "56", "data_vencimento": "2020-02-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "situacoes": [ { "situacao": { "id": "23", "situacao": "Em aberto", "observacao": "Compra cadastrada", "funcionario": "João da Silva", "data": "2020-01-27 11:15:02" } } ], "produtos": [ { "produto": { "id": "38", "produto_id": "45", "variacao_id": "233", "nome_produto": "mouse", "detalhes": "Nenhum detalhe", "possui_variacao": "0", "unidade": "UND", "quantidade": "1.00", "quantidade_saida": "1.00", "valor_custo": "1.10", "valor_total": "1.10", "largura": "0.000", "altura": "0.000" } } ], "campos_extras": [] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de emissão da compra", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Só compras de produtos: compra de serviço (tipo S em /relatorios/compras) não aparece aqui, mas abre em /compras/{id}. Sem data_inicio/data_fim vem o histórico inteiro, não o mês atual: para perguntas de período mande as datas e cite o recorte. Sem loja_id entra só a loja padrão da chave; para todas as lojas mande loja vazio. Sem situacao_id somem as compras em situação oculta da listagem — /situacoes_compras não diz quais são ocultas; com codigo ou situacao_id elas aparecem. codigo é o número da compra na tela, diferente do id. fornecedor_id filtra pelo id; para busca por nome use /relatorios/compras com fornecedor. Para total comprado no período use /relatorios/compras (já somado): data é só uma página, nunca some as linhas. Lista vazia volta 200 com data [] e message \"Não há dados!\". Valores vêm com ponto (\"1844.70\") e datas AAAA-MM-DD.", "description": "Compras de mercadoria (tela Compras), com produtos, parcelas de pagamento, histórico de situações e campos extras. Cada linha da listagem já vem completa, no mesmo formato do detalhe.\n\nUsuário sem a permissão Compras/ComprasProdutos/liberado_usuario só vê as compras que ele lançou. Ordem: emissão mais recente primeiro.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da compra. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Estoque e compras" ], "summary": "Cadastrar compras", "operationId": "estoque_compras_cadastrar", "x-modulo": "estoque", "x-recurso": "compras", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "fornecedor_id": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "data_emissao": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "numero_nfe": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "pagar_frete": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_impostos": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" }, "forma_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "intervalo_dias": { "type": [ "string", "null" ] }, "numero_parcelas": { "type": "string" }, "data_primeira_parcela": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "cadastrado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "id": { "type": "string" }, "situacao": { "type": "string" }, "observacao": { "type": "string" }, "funcionario": { "type": "string" }, "data": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "quantidade_saida": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_total": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" } } } } } }, "campos_extras": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "24", "codigo": "395", "fornecedor_id": "3", "nome_fornecedor": "BETEL TECNOLOGIA SOFTWARE LTDA", "data_emissao": "2020-01-27", "situacao_id": "13", "nome_situacao": "Em aberto", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "numero_nfe": null, "valor_frete": "0.00", "pagar_frete": "1", "transportadora_id": "1", "nome_transportadora": "Transportadora", "valor_produtos": "1.10", "valor_impostos": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "1.10", "forma_pagamento": "P", "forma_pagamento_id": "579722", "intervalo_dias": null, "numero_parcelas": "3", "data_primeira_parcela": null, "observacoes": "Valor Aprox dos Tributos: R$ 0,26", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "cadastrado_em": "2020-01-27 11:15:02", "pagamentos": [ { "pagamento": { "id": "55", "data_vencimento": "2020-01-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "id": "56", "data_vencimento": "2020-02-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "situacoes": [ { "situacao": { "id": "23", "situacao": "Em aberto", "observacao": "Compra cadastrada", "funcionario": "João da Silva", "data": "2020-01-27 11:15:02" } } ], "produtos": [ { "produto": { "id": "38", "produto_id": "45", "variacao_id": "233", "nome_produto": "mouse", "detalhes": "Nenhum detalhe", "possui_variacao": "0", "unidade": "UND", "quantidade": "1.00", "quantidade_saida": "1.00", "valor_custo": "1.10", "valor_total": "1.10", "largura": "0.000", "altura": "0.000" } } ], "campos_extras": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `codigo`, `fornecedor_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fornecedor_id": { "type": "string" }, "data_emissao": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "transportadora_id": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": [ "string", "null" ] }, "forma_pagamento_id": { "type": "integer" }, "plano_contas_id": { "type": "integer" }, "numero_parcelas": { "type": "integer" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "possui_variacao": { "type": "integer" }, "quantidade_saida": { "type": "integer" }, "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "largura": { "type": "integer" }, "altura": { "type": "integer" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "valor_custo": { "type": "string" } } } } } } } }, "example": { "fornecedor_id": "3", "data_emissao": "2020-01-27", "situacao_id": "13", "nome_situacao": "Em aberto", "transportadora_id": "1", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 0", "observacoes": "Valor Aprox dos Tributos: R$ 0,26", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "valor_frete": null, "forma_pagamento_id": 579722, "plano_contas_id": 4878060, "numero_parcelas": 3, "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "possui_variacao": 0, "quantidade_saida": 1, "produto_id": "45", "nome_produto": "mouse", "variacao_id": "", "detalhes": "Nenhum detalhe", "largura": 0, "altura": 0, "unidade": "CX", "quantidade": "1.00", "valor_custo": "1.10" } } ] } } } } } }, "/compras/{id}": { "get": { "tags": [ "Estoque e compras" ], "summary": "Visualizar compras", "operationId": "estoque_compras_visualizar", "x-modulo": "estoque", "x-recurso": "compras", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "fornecedor_id": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "data_emissao": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "numero_nfe": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "pagar_frete": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_impostos": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" }, "forma_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "intervalo_dias": { "type": [ "string", "null" ] }, "numero_parcelas": { "type": "string" }, "data_primeira_parcela": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "cadastrado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "id": { "type": "string" }, "situacao": { "type": "string" }, "observacao": { "type": "string" }, "funcionario": { "type": "string" }, "data": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "quantidade_saida": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_total": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" } } } } } }, "campos_extras": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "24", "codigo": "395", "fornecedor_id": "3", "nome_fornecedor": "BETEL TECNOLOGIA SOFTWARE LTDA", "data_emissao": "2020-01-27", "situacao_id": "13", "nome_situacao": "Em aberto", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "numero_nfe": null, "valor_frete": "0.00", "pagar_frete": "1", "transportadora_id": "1", "nome_transportadora": "Transportadora", "valor_produtos": "1.10", "valor_impostos": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "1.10", "forma_pagamento": "P", "forma_pagamento_id": "579722", "intervalo_dias": null, "numero_parcelas": "3", "data_primeira_parcela": null, "observacoes": "Valor Aprox dos Tributos: R$ 0,26", "observacoes_interna": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.", "cadastrado_em": "2020-01-27 11:15:02", "pagamentos": [ { "pagamento": { "id": "55", "data_vencimento": "2020-01-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "id": "56", "data_vencimento": "2020-02-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "situacoes": [ { "situacao": { "id": "23", "situacao": "Em aberto", "observacao": "Compra cadastrada", "funcionario": "João da Silva", "data": "2020-01-27 11:15:02" } } ], "produtos": [ { "produto": { "id": "38", "produto_id": "45", "variacao_id": "233", "nome_produto": "mouse", "detalhes": "Nenhum detalhe", "possui_variacao": "0", "unidade": "UND", "quantidade": "1.00", "quantidade_saida": "1.00", "valor_custo": "1.10", "valor_total": "1.10", "largura": "0.000", "altura": "0.000" } } ], "campos_extras": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Abre também compra de serviço (que não sai na listagem). 404 quando a compra não existe, é de loja que o usuário da chave não acessa ou, sem Compras/ComprasProdutos/liberado_usuario, foi lançada por outro usuário. produtos traz cada item com quantidade e valor_custo unitário; pagamentos são as parcelas; situacoes é o histórico de mudanças de situação (a atual está em nome_situacao).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Estoque e compras" ], "summary": "Editar compras", "operationId": "estoque_compras_editar", "x-modulo": "estoque", "x-recurso": "compras", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "fornecedor_id": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "data_emissao": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "numero_nfe": { "type": [ "string", "null" ] }, "valor_frete": { "type": "string" }, "pagar_frete": { "type": "string" }, "transportadora_id": { "type": "string" }, "nome_transportadora": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_impostos": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" }, "forma_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "intervalo_dias": { "type": [ "string", "null" ] }, "numero_parcelas": { "type": "string" }, "data_primeira_parcela": { "type": [ "string", "null" ] }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "cadastrado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "situacoes": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "id": { "type": "string" }, "situacao": { "type": "string" }, "observacao": { "type": "string" }, "funcionario": { "type": "string" }, "data": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "quantidade_saida": { "type": "string" }, "valor_custo": { "type": "string" }, "valor_total": { "type": "string" }, "largura": { "type": "string" }, "altura": { "type": "string" } } } } } }, "campos_extras": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "17", "codigo": "388", "fornecedor_id": "3", "nome_fornecedor": "BETEL TECNOLOGIA SOFTWARE LTDA", "data_emissao": "2020-01-27", "situacao_id": "13", "nome_situacao": "Em aberto", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "numero_nfe": null, "valor_frete": "0.00", "pagar_frete": "1", "transportadora_id": "1", "nome_transportadora": "Transportadora", "valor_produtos": "2.20", "valor_impostos": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_total": "2.20", "forma_pagamento": "P", "forma_pagamento_id": "579722", "intervalo_dias": null, "numero_parcelas": "3", "data_primeira_parcela": null, "observacoes": "Sed sed laoreet nisi, condimentum sollicitudin lectus.", "observacoes_interna": "Donec enim dui, luctus ut felis rhoncus, egestas aliquet quam.", "cadastrado_em": "2020-01-24 14:31:21", "pagamentos": [ { "pagamento": { "id": "43", "data_vencimento": "2020-01-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "id": "44", "data_vencimento": "2020-02-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "situacoes": [ { "situacao": { "id": "16", "situacao": "Em aberto", "observacao": "Compra cadastrada", "funcionario": "João da Silva", "data": "2020-01-24 14:31:22" } } ], "produtos": [ { "produto": { "id": "32", "produto_id": "45", "variacao_id": "233", "nome_produto": "mouse", "detalhes": "Nenhum detalhe", "possui_variacao": "0", "unidade": "CX", "quantidade": "2.00", "quantidade_saida": "1.00", "valor_custo": "1.10", "valor_total": "2.20", "largura": "0.000", "altura": "0.000" } } ], "campos_extras": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `codigo`, `fornecedor_id`, `situacao_id`, `data`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fornecedor_id": { "type": "string" }, "data_emissao": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "transportadora_id": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "valor_frete": { "type": [ "string", "null" ] }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "possui_variacao": { "type": "integer" }, "quantidade_saida": { "type": "integer" }, "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao_id": { "type": "string" }, "detalhes": { "type": "string" }, "largura": { "type": "integer" }, "altura": { "type": "integer" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "valor_custo": { "type": "string" } } } } } } } }, "example": { "fornecedor_id": "3", "data_emissao": "2020-01-27", "situacao_id": "13", "nome_situacao": "Em aberto", "transportadora_id": "1", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 0", "observacoes": "Sed sed laoreet nisi, condimentum sollicitudin lectus.", "observacoes_interna": "Donec enim dui, luctus ut felis rhoncus, egestas aliquet quam. ", "valor_frete": null, "pagamentos": [ { "pagamento": { "data_vencimento": "2020-01-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } }, { "pagamento": { "data_vencimento": "2020-02-27", "valor": "0.37", "forma_pagamento_id": "579722", "nome_forma_pagamento": "BB", "plano_contas_id": "4878060", "nome_plano_conta": "Aluguel", "observacao": "Lorem Ipsum is simply dummy text of the printing and typesetting industry." } } ], "produtos": [ { "produto": { "possui_variacao": 0, "quantidade_saida": 1, "produto_id": "45", "nome_produto": "mouse", "variacao_id": "", "detalhes": "Nenhum detalhe", "largura": 0, "altura": 0, "unidade": "CX", "quantidade": "2.00", "valor_custo": "1.10" } } ] } } } } }, "delete": { "tags": [ "Estoque e compras" ], "summary": "Deletar compras", "operationId": "estoque_compras_deletar", "x-modulo": "estoque", "x-recurso": "compras", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Compra removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/compras/gerar_parcelas": { "post": { "tags": [ "Estoque e compras" ], "summary": "Gerar parcelas compras", "operationId": "estoque_compras_gerar_parcelas", "x-modulo": "estoque", "x-recurso": "compras", "x-operacao": "gerar_parcelas", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "number" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "data_vencimento": "2020-01-27", "valor": 33.3299999999999982946974341757595539093017578125 }, { "data_vencimento": "2020-02-27", "valor": 33.3299999999999982946974341757595539093017578125 }, { "data_vencimento": "2020-03-27", "valor": 33.340000000000003410605131648480892181396484375 } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `valor_total`, `numero_parcelas`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "valor_total": { "type": "integer" }, "intervalo_dias": { "type": "integer" }, "data_primeira_parcela": { "type": "string" }, "numero_parcelas": { "type": "integer" } } }, "example": { "valor_total": 100, "intervalo_dias": 30, "data_primeira_parcela": "2020-01-27", "numero_parcelas": 3 } } } } } }, "/situacoes_compras": { "get": { "tags": [ "Estoque e compras" ], "summary": "Listar situações de compras", "operationId": "estoque_situacoes_compras_listar", "x-modulo": "estoque", "x-recurso": "situacoes_compras", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "texto — parte do nome da situação", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "padrao": { "type": "string" }, "tipo_lancamento": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 5, "total_da_pagina": 5, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "15", "nome": "Confirmada", "padrao": "0", "tipo_lancamento": "1" }, { "id": "13", "nome": "Em aberto", "padrao": "1", "tipo_lancamento": "0" }, { "id": "14", "nome": "Em andamento", "padrao": "0", "tipo_lancamento": "0" }, { "id": "16", "nome": "Cancelada", "padrao": "0", "tipo_lancamento": "0" }, { "id": "4010", "nome": "Finalizado", "padrao": "0", "tipo_lancamento": "1" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/SituacoesCompras/index", "x-ia": "As situações são de cada empresa (nomes e ids livres): nunca suponha id. tipo_lancamento diz o que a compra faz ao entrar nesta situação: 0 = não lança, 1 = lança estoque e financeiro, 2 = só estoque, 3 = só financeiro. padrao = 1 marca a situação padrão. A resposta não diz se a situação aparece na listagem de /compras.", "description": "Situações de compra da empresa (tela Compras > Situações), só leitura. Os ids servem de situacao_id em /compras e nos relatórios de compras.\n\n**Permissão exigida:** `Compras/SituacoesCompras/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ajustes_estoques": { "get": { "tags": [ "Estoque e compras" ], "summary": "Listar ajustes de estoque", "operationId": "estoque_ajustes_estoques_listar", "x-modulo": "estoque", "x-recurso": "ajustes_estoques", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data do ajuste)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "movimentacao", "in": "query", "required": false, "description": "E = só entradas, S = só saídas; sem ele entram as duas", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "ajustes": { "type": "integer" }, "entradas": { "type": "integer" }, "saidas": { "type": "integer" }, "valor_entradas": { "type": "integer" }, "valor_saidas": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "movimentacao": { "type": "string" }, "nome_movimentacao": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_frete": { "type": "integer" }, "valor_total": { "type": "integer" }, "observacoes": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data do ajuste", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "ajustes": 1, "entradas": 1, "saidas": 0, "valor_entradas": 50, "valor_saidas": 0 }, "itens": [ { "id": "203", "codigo": "1", "movimentacao": "E", "nome_movimentacao": "Entrada", "loja_id": "65", "nome_loja": "Master", "valor_frete": 0, "valor_total": 50, "observacoes": "Teste local da API (GCK-22566)", "nome_usuario": "Teste API", "cadastrado_em": "2026-10-27 18:03:18" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Estoque/AjustesEstoques/index", "x-periodo": { "data": "a data do ajuste", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Ajuste é correção manual de estoque, não venda nem compra. data.totais conta os ajustes de entrada e de saída do período e soma o valor (custo) de cada lado — valor_* só vem para quem tem Produtos/visualizar_valor_custo. Os produtos de cada ajuste estão em /ajustes_estoques/{id}. data.itens é só uma página.", "description": "Ajustes manuais de estoque (entrada ou saída lançada na tela Estoque > Ajustes), só leitura. A listagem traz o período com os totais; o detalhe traz os produtos ajustados.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do ajuste. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Estoque/AjustesEstoques/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ajustes_estoques/{id}": { "get": { "tags": [ "Estoque e compras" ], "summary": "Visualizar ajustes de estoque", "operationId": "estoque_ajustes_estoques_visualizar", "x-modulo": "estoque", "x-recurso": "ajustes_estoques", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "movimentacao": { "type": "string" }, "nome_movimentacao": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "valor_frete": { "type": "integer" }, "valor_total": { "type": "integer" }, "observacoes": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "estoque_id": { "type": "string" }, "codigo": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao": { "type": [ "string", "null" ] }, "unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_total": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "203", "codigo": "1", "movimentacao": "E", "nome_movimentacao": "Entrada", "loja_id": "65", "nome_loja": "Master", "valor_frete": 0, "valor_total": 50, "observacoes": "Teste local da API (GCK-22566)", "nome_usuario": "Teste API", "cadastrado_em": "2026-10-27 18:03:18", "produtos": [ { "id": "257", "produto_id": "31998", "estoque_id": "294470", "codigo": "2050460512009", "nome_produto": "Coca cola", "variacao": null, "unidade": "UN", "quantidade": 5, "valor_custo": 10, "valor_total": 50 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Estoque/AjustesEstoques/visualizar", "x-ia": "404 também quando o ajuste é de uma loja que o usuário da chave não acessa. valor_custo/valor_total dos produtos só vêm com a permissão Produtos/visualizar_valor_custo.", "description": "**Permissão exigida:** `Estoque/AjustesEstoques/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_compras": { "get": { "tags": [ "Estoque e compras" ], "summary": "Listar campos extras compras", "operationId": "estoque_atributos_compras_listar", "x-modulo": "estoque", "x-recurso": "atributos_compras", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "texto — parte do nome do campo extra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "obrigatorio": { "type": "string" }, "exibir_impressao": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "51", "nome": "TESTE GCK-22721 Centro", "tipo": "texto_simples", "obrigatorio": "0", "exibir_impressao": "Quando preenchido", "modificado_em": "2026-10-29 17:32:10", "cadastrado_em": "2026-10-29 17:32:10" }, { "id": "52", "nome": "TESTE GCK-22721 Tipo", "tipo": "selecao_multipla", "obrigatorio": "0", "exibir_impressao": "Sim", "modificado_em": "2026-10-29 17:32:10", "cadastrado_em": "2026-10-29 17:32:10" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/AtributosCompras/index", "x-ia": "São os campos extras que a empresa criou para a compra e a cotação (valem para a empresa inteira, não por loja). exibir_impressao diz se o campo sai na impressão: Quando preenchido, Sim ou Não. As opções dos tipos check_list e selecao_multipla estão em /atributos_compras/{id}.", "description": "Campos extras configurados para compras e cotações (tela Compras > Campos extras), só leitura. Mesmo formato de /atributos_vendas.\n\n**Permissão exigida:** `Compras/AtributosCompras/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_compras/{id}": { "get": { "tags": [ "Estoque e compras" ], "summary": "Visualizar campos extras compras", "operationId": "estoque_atributos_compras_visualizar", "x-modulo": "estoque", "x-recurso": "atributos_compras", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "obrigatorio": { "type": "string" }, "exibir_impressao": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "52", "nome": "TESTE GCK-22721 Tipo", "tipo": "selecao_multipla", "obrigatorio": "0", "exibir_impressao": "Sim", "modificado_em": "2026-10-29 17:32:10", "cadastrado_em": "2026-10-29 17:32:10", "opcoes": [ { "id": "12", "atributo_id": "52", "nome": "Urgente" }, { "id": "13", "atributo_id": "52", "nome": "Normal" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/AtributosCompras/visualizar", "x-ia": "opcoes só vem preenchida nos tipos check_list (seleção única) e selecao_multipla.", "description": "**Permissão exigida:** `Compras/AtributosCompras/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/cotacoes": { "get": { "tags": [ "Estoque e compras" ], "summary": "Listar cotações de compra", "operationId": "estoque_cotacoes_listar", "x-modulo": "estoque", "x-recurso": "cotacoes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (entra a cotação cuja data OU prazo de recebimento é a partir deste dia)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período (data OU prazo de recebimento até este dia)", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número da cotação; com ele o período é ignorado", "schema": { "type": "string" } }, { "name": "respondido", "in": "query", "required": false, "description": "1 = cotações marcadas como respondidas, 0 = não respondidas; sem ele entram as duas", "schema": { "type": "string" } }, { "name": "fornecedor", "in": "query", "required": false, "description": "texto — parte do nome ou da razão social de um fornecedor da cotação", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "texto — parte do nome de um produto cotado", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "texto — parte do nome de um serviço cotado", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "cotacoes": { "type": "integer" }, "nao_enviadas": { "type": "integer" }, "respondidas": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "data": { "type": "string" }, "prazo_recebimento": { "type": [ "string", "null" ] }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "enviado": { "type": "boolean" }, "respondido": { "type": "boolean" }, "situacao": { "type": "string" }, "fornecedores": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "respondido": { "type": "boolean" } } } }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data da cotação ou o prazo de recebimento", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "cotacoes": 2, "nao_enviadas": 1, "respondidas": 0 }, "itens": [ { "id": "277", "codigo": "90002", "data": "2026-10-28", "prazo_recebimento": null, "loja_id": "65", "nome_loja": "MENU TECNOLOGIA - Fantasia", "enviado": false, "respondido": false, "situacao": "Não enviado", "fornecedores": [ { "nome": "Fornecedor Teste Claude", "respondido": false } ], "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 17:32:10" }, { "id": "276", "codigo": "90001", "data": "2026-10-29", "prazo_recebimento": "2026-11-08", "loja_id": "65", "nome_loja": "MENU TECNOLOGIA - Fantasia", "enviado": true, "respondido": false, "situacao": "Respondido (1 de 2)", "fornecedores": [ { "nome": "Fornecedor Teste Claude", "respondido": true }, { "nome": "Fornecedor Teste", "respondido": false } ], "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 17:32:10" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/Cotacoes/index", "x-periodo": { "data": "a data da cotação ou o prazo de recebimento", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Cotação é pedido de preço a fornecedores, não é compra: valor só existe no detalhe (/cotacoes/{id}), por fornecedor. O período pega a data da cotação OU o prazo de recebimento, então uma cotação antiga com prazo no período também entra. situacao resume as respostas (Não enviado, Aguardando, Respondido (1 de 2), Respondido); respondido = true só quando a cotação inteira foi marcada como respondida. Com codigo o período não é aplicado, mesmo que meta.periodo mostre o mês atual. data.itens é só uma página.", "description": "Cotações de compra enviadas aos fornecedores (tela Compras > Cotações), só leitura. A listagem traz o período com os totais e a situação da resposta de cada fornecedor; o detalhe traz os itens, o preço que cada fornecedor respondeu, os campos extras e os anexos.\n\nUsuário sem a permissão Compras/Cotacoes/liberado_usuario só vê as cotações que ele lançou.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da cotação ou o prazo de recebimento. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Compras/Cotacoes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/cotacoes/{id}": { "get": { "tags": [ "Estoque e compras" ], "summary": "Visualizar cotações de compra", "operationId": "estoque_cotacoes_visualizar", "x-modulo": "estoque", "x-recurso": "cotacoes", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "data": { "type": "string" }, "prazo_recebimento": { "type": [ "string", "null" ] }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "enviado": { "type": "boolean" }, "respondido": { "type": "boolean" }, "situacao": { "type": "string" }, "fornecedores": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fornecedor_id": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "email": { "type": "string" }, "respondido": { "type": "boolean" }, "observacoes": { "type": "string" }, "pagar_frete": { "type": "boolean" }, "valor_produtos": { "type": "integer" }, "valor_frete": { "type": "integer" }, "valor_total": { "type": "integer" }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "estoque_id": { "type": [ "string", "null" ] }, "tipo": { "type": "string" }, "codigo": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao": { "type": [ "string", "null" ] }, "detalhes": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "largura": { "type": "integer" }, "altura": { "type": "integer" }, "valor_custo": { "type": [ "string", "null" ] }, "sub_total": { "type": [ "string", "null" ] } } } } } } }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_interna": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "estoque_id": { "type": [ "string", "null" ] }, "tipo": { "type": "string" }, "codigo": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao": { "type": [ "string", "null" ] }, "detalhes": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "largura": { "type": "integer" }, "altura": { "type": "integer" } } } }, "campos_extras": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "277", "codigo": "90002", "data": "2026-10-28", "prazo_recebimento": null, "loja_id": "65", "nome_loja": "MENU TECNOLOGIA - Fantasia", "enviado": false, "respondido": false, "situacao": "Não enviado", "fornecedores": [ { "id": "322", "fornecedor_id": "545", "nome_fornecedor": "Fornecedor Teste Claude", "email": "teste@example.com", "respondido": false, "observacoes": "TESTE GCK-22721", "pagar_frete": false, "valor_produtos": 0, "valor_frete": 0, "valor_total": 0, "itens": [ { "id": "392", "produto_id": "31998", "estoque_id": null, "tipo": "P", "codigo": "2050460512009", "nome_produto": "Coca cola", "variacao": null, "detalhes": "TESTE GCK-22721", "unidade": "UN", "quantidade": 5, "largura": 0, "altura": 0, "valor_custo": null, "sub_total": null } ] } ], "nome_usuario": "João do BD COMPARTILHADO!", "cadastrado_em": "2026-10-29 17:32:10", "observacoes": "TESTE GCK-22721", "observacoes_interna": "", "produtos": [ { "id": "392", "produto_id": "31998", "estoque_id": null, "tipo": "P", "codigo": "2050460512009", "nome_produto": "Coca cola", "variacao": null, "detalhes": "TESTE GCK-22721", "unidade": "UN", "quantidade": 5, "largura": 0, "altura": 0 } ], "campos_extras": [], "anexos": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/Cotacoes/visualizar", "x-ia": "404 também quando a cotação é de uma loja que o usuário da chave não acessa ou, sem Compras/Cotacoes/liberado_usuario, foi lançada por outro usuário. Em fornecedores, cada um traz os itens com o preço que respondeu (valor_custo unitário e sub_total = valor_custo × quantidade × largura × altura); valor_total do fornecedor soma o frete só quando pagar_frete = true. Fornecedor que não respondeu vem com os preços zerados. Para comparar propostas, compare valor_total entre fornecedores que responderam.", "description": "**Permissão exigida:** `Compras/Cotacoes/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/movimentacoes_estoque": { "get": { "tags": [ "Estoque e compras" ], "summary": "Listar movimentações de estoque", "operationId": "estoque_movimentacoes_estoque_listar", "x-modulo": "estoque", "x-recurso": "movimentacoes_estoque", "x-operacao": "listar", "parameters": [ { "name": "produto_id", "in": "query", "required": false, "description": "int — OBRIGATÓRIO: o produto — ids em `/produtos`", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da movimentação)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "movimentacao", "in": "query", "required": false, "description": "E = só entradas, S = só saídas; sem ele entram as duas", "schema": { "type": "string" } }, { "name": "lote_id", "in": "query", "required": false, "description": "int — só as movimentações de um lote (empresa com controle de lote)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "produto_id": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "movimentacoes": { "type": "integer" }, "quantidade_entradas": { "type": "integer" }, "quantidade_saidas": { "type": "integer" }, "valor_entradas": { "type": "integer" }, "valor_saidas": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "string" }, "movimentacao": { "type": "string" }, "tipo": { "type": "string" }, "descricao": { "type": "string" }, "entidade": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "estoque_id": { "type": "string" }, "variacao": { "type": [ "string", "null" ] }, "quantidade": { "type": "integer" }, "saldo": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_total": { "type": "integer" }, "lote_id": { "type": [ "string", "null" ] }, "numero_lote": { "type": [ "string", "null" ] } } } }, "produto": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "possui_variacao": { "type": "boolean" }, "controle_lote": { "type": "boolean" } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data da movimentação", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "produto_id": "31998" }, "total_registros": 35, "pagina": 1, "limite": 2, "total_paginas": 18, "cache": false }, "data": { "totais": { "movimentacoes": 35, "quantidade_entradas": 22, "quantidade_saidas": 46, "valor_entradas": 220, "valor_saidas": 460 }, "itens": [ { "id": "33787", "data": "2026-09-28 19:59:49", "movimentacao": "S", "tipo": "Saída", "descricao": "Lançamento da venda de nº 28978003", "entidade": "Cliente TESTE SR", "loja_id": "65", "nome_loja": "Master", "estoque_id": "294470", "variacao": null, "quantidade": 2, "saldo": -22, "valor_custo": 10, "valor_total": 20, "lote_id": null, "numero_lote": null }, { "id": "33786", "data": "2026-09-28 19:59:49", "movimentacao": "E", "tipo": "Entrada", "descricao": "Estorno da venda de nº 28978003", "entidade": "Consumidor", "loja_id": "65", "nome_loja": "Master", "estoque_id": "294470", "variacao": null, "quantidade": 2, "saldo": -20, "valor_custo": 10, "valor_total": 20, "lote_id": null, "numero_lote": null } ], "produto": { "id": "31998", "nome": "Coca cola", "possui_variacao": false, "controle_lote": false } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Produtos/movimentacoes_estoque", "x-periodo": { "data": "a data da movimentação", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Sempre de UM produto (produto_id); sem ele a API responde 400. Estorno de venda aparece como entrada e o novo lançamento da venda como saída — não conte os dois como vendas. saldo é o saldo do estoque (produto + variação + loja) logo depois daquela movimentação; o saldo atual é o da movimentação mais recente de cada estoque_id. data.totais soma as quantidades de entrada e de saída do período inteiro; valor_entradas/valor_saidas (e valor_custo/valor_total das linhas) são custo e só vêm para quem tem Produtos/visualizar_valor_custo. data.itens é só uma página, mais recente primeiro.", "description": "Entradas e saídas de estoque de um produto no período (venda, compra, ajuste, transferência, estorno…), com o saldo depois de cada movimentação e os totais. É a mesma regra da tela Produtos > Movimentações de estoque.\n\n**Campos obrigatórios:** `produto_id`\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da movimentação. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Produtos/movimentacoes_estoque` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/compras": { "get": { "tags": [ "Estoque e compras" ], "summary": "Consultar relatório de compras", "operationId": "estoque_relatorio_compras_listar", "x-modulo": "estoque", "x-recurso": "relatorio_compras", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão da compra)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "P = compra de produtos, S = serviços contratados; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação da compra (ids em /situacoes_compras; as situações são de cada empresa)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (filtro exato)", "schema": { "type": "string" } }, { "name": "fornecedor", "in": "query", "required": false, "description": "string — nome ou razão social do fornecedor (busca parcial)", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — usuário que lançou a compra", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — um centro de custo", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "valor": { "type": "integer" }, "frete": { "type": "integer" }, "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome_loja": { "type": "string" }, "data_emissao": { "type": "string" }, "nome_situacao": { "type": "string" }, "valor_total": { "type": "integer" }, "fornecedor_id": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "valor_frete": { "type": "integer" }, "nota_fiscal_id": { "type": "string" }, "numero_nfe": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "atributos": { "type": "object", "properties": [] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de emissão da compra", "inicio": "2025-11-01", "fim": "2026-10-26", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 8, "pagina": 1, "limite": 2, "total_paginas": 4, "cache": false }, "data": { "totais": { "valor": 212, "frete": 0, "quantidade": 8 }, "itens": [ { "id": "504", "codigo": "8", "nome_loja": "11", "data_emissao": "2026-09-05", "nome_situacao": "Em aberto (teste)", "valor_total": 25, "fornecedor_id": "545", "nome_fornecedor": "Fornecedor Teste Claude", "valor_frete": 0, "nota_fiscal_id": "", "numero_nfe": "7000504", "nome_centro_custo": "Centro de custo (teste Claude)", "atributos": [] }, { "id": "503", "codigo": "7", "nome_loja": "11", "data_emissao": "2026-09-08", "nome_situacao": "Em aberto (teste)", "valor_total": 25, "fornecedor_id": "545", "nome_fornecedor": "Fornecedor Teste Claude", "valor_frete": 0, "nota_fiscal_id": "", "numero_nfe": "7000503", "nome_centro_custo": "Centro de custo (teste Claude)", "atributos": [] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/ComprasProdutos/relatorio_compras", "x-periodo": { "data": "a data de emissão da compra", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: responda quantidade e valor juntos (\"X compras, R$ Y\") e cite o período de meta.periodo e as lojas de meta.loja_id. data.itens é só uma página — nunca some as linhas. totais.frete JÁ ESTÁ DENTRO de totais.valor (o valor da compra é produtos + frete): cite o frete como parte do total, nunca some de novo. Compra é o que a empresa adquiriu de fornecedores — não é venda, estoque nem conta paga. Sem tipo, mistura compra de produtos e serviços contratados. Entram compras de TODAS as situações (inclusive cancelada e as ocultas da listagem /compras): para só as efetivadas, filtre situacao_id. Usuário sem a permissão de ver compras de outros usuários só enxerga as que ele lançou. Zerado: diga \"nenhuma compra no período, R$ 0,00\" e o recorte usado.", "description": "Compras do período já somadas — quantidade, valor e frete — e a lista das compras. É a mesma regra do relatório de compras da tela Compras > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da compra. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Compras/ComprasProdutos/relatorio_compras` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/cotacoes": { "get": { "tags": [ "Estoque e compras" ], "summary": "Consultar relatório de cotações", "operationId": "estoque_relatorio_cotacoes_listar", "x-modulo": "estoque", "x-recurso": "relatorio_cotacoes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da cotação)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — cotações enviadas a um fornecedor", "schema": { "type": "string" } }, { "name": "fornecedor", "in": "query", "required": false, "description": "texto — parte do nome ou da razão social do fornecedor", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — cotações lançadas por um usuário (ids em /usuarios)", "schema": { "type": "string" } }, { "name": "respondido", "in": "query", "required": false, "description": "1 = cotações marcadas como respondidas, 0 = não respondidas; sem ele entram as duas", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "cotacoes": { "type": "integer" }, "respondidas": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "data": { "type": "string" }, "nome_loja": { "type": "string" }, "respondido": { "type": "boolean" }, "situacao": { "type": "string" }, "fornecedores": { "type": "array", "items": { "type": "string" } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data da cotação", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": true }, "data": { "totais": { "cotacoes": 2, "respondidas": 0 }, "itens": [ { "id": "277", "codigo": "90002", "data": "2026-10-28", "nome_loja": "MENU TECNOLOGIA - Fantasia", "respondido": false, "situacao": "Não enviado", "fornecedores": [ "Fornecedor Teste Claude" ] }, { "id": "276", "codigo": "90001", "data": "2026-10-29", "nome_loja": "MENU TECNOLOGIA - Fantasia", "respondido": false, "situacao": "Respondido (1 de 2)", "fornecedores": [ "Fornecedor Teste Claude", "Fornecedor Teste" ] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/Cotacoes/relatorio_cotacoes", "x-periodo": { "data": "a data da cotação", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "data.totais.cotacoes é o número de cotações do período e respondidas as marcadas como respondidas — responda com eles e cite o período de meta.periodo; data.itens é só uma página, nunca conte as linhas. Aqui o período é só a data da cotação (a listagem /cotacoes também considera o prazo de recebimento). Cotação não tem valor neste relatório: os preços de cada fornecedor estão em /cotacoes/{id}. Cotação não é compra. Zerado: diga \"nenhuma cotação no período\" e repita os filtros.", "description": "Cotações de compra do período com os fornecedores e a situação das respostas. É a mesma regra do relatório de cotações da tela Compras > Relatórios.\n\nUsuário sem a permissão Compras/Cotacoes/liberado_usuario só vê as cotações que ele lançou.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da cotação. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Compras/Cotacoes/relatorio_cotacoes` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/estoque": { "get": { "tags": [ "Estoque e compras" ], "summary": "Consultar relatório de estoque", "operationId": "estoque_relatorio_estoque_listar", "x-modulo": "estoque", "x-recurso": "relatorio_estoque", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa (a quantidade é somada entre as lojas)", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — parte do nome do produto", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — trecho do código ou do código de barras do produto, ou o código/código de barras exato de uma variação", "schema": { "type": "string" } }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de produto (inclui os subgrupos); SG = sem grupo — ids em `/grupos_produtos`", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — fornecedor vinculado ao produto — ids em `/fornecedores`", "schema": { "type": "string" } }, { "name": "fornecedor", "in": "query", "required": false, "description": "string — nome ou razão social do fornecedor vinculado (busca parcial)", "schema": { "type": "string" } }, { "name": "localizacao", "in": "query", "required": false, "description": "string — parte da localização no estoque", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só produtos ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "situacao_estoque", "in": "query", "required": false, "description": "1 = estoque menor ou igual ao mínimo, 2 = maior ou igual ao máximo, 3 = acima de zero, 4 = menor ou igual a zero, 5 = negativo, 6 = abaixo do mínimo; sem ele entram todos; outro valor responde 400", "schema": { "type": "string" } }, { "name": "valor_venda_id", "in": "query", "required": false, "description": "ids separados por vírgula (máximo 10) — tabelas de preço calculadas em valores_venda; sem ele, as 10 primeiras por nome, como a tela abre — ids em `/tipos_valores_produtos`", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "itens": { "type": "integer" }, "estoque": { "type": "integer" }, "custo_total": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "codigo": { "type": "string" }, "codigo_barra": { "type": "string" }, "nome": { "type": "string" }, "variacao": { "type": [ "string", "null" ] }, "unidade": { "type": "string" }, "estoque": { "type": "integer" }, "estoque_minimo": { "type": "integer" }, "estoque_maximo": { "type": "integer" }, "localizacao": { "type": "string" }, "valor_custo": { "type": "integer" }, "custo_saida": { "type": "integer" }, "custo_total": { "type": "integer" }, "valores_venda": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "valor": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "valores_venda": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "total": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "itens": 1, "estoque": -24, "custo_total": -240 }, "itens": [ { "produto_id": "31998", "codigo": "2050460512009", "codigo_barra": "2000129950406", "nome": "Coca cola", "variacao": null, "unidade": "UN", "estoque": -24, "estoque_minimo": 0, "estoque_maximo": 0, "localizacao": "", "valor_custo": 10, "custo_saida": 10, "custo_total": -240, "valores_venda": [ { "id": "91657", "nome": "Padrão", "valor": 15, "total": -360 } ] } ], "valores_venda": [ { "id": "91657", "nome": "Padrão", "total": -360 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "MovimentacoesEstoque/relatorio_estoque_produtos", "x-ia": "Não tem período: é a posição de estoque de AGORA (não serve para estoque numa data passada — para isso use /relatorios/inventario). Só entram produtos que movimentam estoque. data.totais.estoque soma as quantidades de todos os produtos, mesmo de unidades diferentes: cite por produto, não como 'unidades'. data.totais.custo_total é o custo do estoque (quantidade × custo ÷ quantidade de saída); estoque negativo deixa o custo negativo e reduz o total. Quem não tem a permissão Produtos/visualizar_valor_custo não recebe valor_custo, custo_saida nem custo_total — diga que o custo não está disponível para este usuário, não que é zero. data.valores_venda traz o valor de venda do estoque inteiro por tabela de preço (não é faturamento). data.itens é só uma página: nunca some as linhas. situacao_estoque compara com o mínimo/máximo cadastrados, e produto sem mínimo ou máximo tem 0: com 2 entra todo produto sem máximo cadastrado, com 1 todo produto zerado sem mínimo — para \"acima do máximo\" ou \"abaixo do mínimo\" confira estoque_maximo/estoque_minimo da linha e descarte os que vêm 0.", "description": "Posição de estoque de hoje por produto e variação — quantidade, mínimo, máximo, custo e o valor de venda do estoque em cada tabela de preço — com os totais. É a mesma regra do relatório de estoque da tela Estoque > Relatórios.\n\n**Permissão exigida:** `MovimentacoesEstoque/relatorio_estoque_produtos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/inventario": { "get": { "tags": [ "Estoque e compras" ], "summary": "Consultar relatório de inventário", "operationId": "estoque_relatorio_inventario_listar", "x-modulo": "estoque", "x-recurso": "relatorio_inventario", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da movimentação)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — parte do nome do produto", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — código ou código de barras do produto (exato)", "schema": { "type": "string" } }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de produto (inclui os subgrupos); SG = sem grupo — ids em `/grupos_produtos`", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — fornecedor vinculado ao produto — ids em `/fornecedores`", "schema": { "type": "string" } }, { "name": "fornecedor", "in": "query", "required": false, "description": "string — nome ou razão social do fornecedor vinculado (busca parcial)", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = só produtos ativos, 0 = só inativos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "situacao_estoque", "in": "query", "required": false, "description": "1 = estoque menor ou igual ao mínimo, 2 = maior ou igual ao máximo, 3 = acima de zero, 4 = menor ou igual a zero, 5 = negativo, 6 = abaixo do mínimo; sem ele entram todos (comparando o saldo final com o mínimo/máximo do estoque)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "loja_id": { "type": "string" }, "produto_id": { "type": "string" }, "estoque_id": { "type": "string" }, "codigo": { "type": "string" }, "codigo_barra": { "type": "string" }, "nome": { "type": "string" }, "unidade": { "type": "string" }, "ncm": { "type": [ "string", "null" ] }, "localizacao": { "type": [ "string", "null" ] }, "saldo_inicial": { "type": "integer" }, "entradas": { "type": "integer" }, "saidas": { "type": "integer" }, "saldo_final": { "type": "integer" }, "custo_medio": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data das movimentações de estoque", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "itens": [ { "loja_id": "65", "produto_id": "31998", "estoque_id": "294470", "codigo": "2050460512009", "codigo_barra": "2000129950406", "nome": "Coca cola", "unidade": "UN", "ncm": null, "localizacao": null, "saldo_inicial": 0, "entradas": 22, "saidas": 44, "saldo_final": -22, "custo_medio": 10 }, { "loja_id": "80764", "produto_id": "31998", "estoque_id": "294473", "codigo": "2050460512009", "codigo_barra": "2000129950406", "nome": "Coca cola", "unidade": "UN", "ncm": null, "localizacao": null, "saldo_inicial": 0, "entradas": 0, "saidas": 2, "saldo_final": -2, "custo_medio": 10 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "MovimentacoesEstoque/relatorio_inventario_estoque", "x-periodo": { "data": "a data das movimentações de estoque", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Só aparecem os estoques que tiveram movimentação no período: produto parado não está na lista, e a ausência não quer dizer estoque zero (a posição atual está em /relatorios/estoque). Cada linha é um estoque — mesmo produto em duas lojas ou duas variações vira duas linhas (loja_id, estoque_id). saldo_final é o saldo depois da última movimentação do período; saldo_inicial = saldo_final + saídas − entradas. custo_medio só vem para quem tem Produtos/visualizar_valor_custo. Não há totais somados: data.itens é só uma página — use meta.total_registros para a quantidade de linhas e nunca some só uma página.", "description": "Inventário do período por estoque (produto, variação e loja): saldo inicial, entradas, saídas, saldo final e custo médio das movimentações. É a mesma regra do relatório de inventário da tela Estoque > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data das movimentações de estoque. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `MovimentacoesEstoque/relatorio_inventario_estoque` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/lotes": { "get": { "tags": [ "Estoque e compras" ], "summary": "Consultar relatório de lotes", "operationId": "estoque_relatorio_lotes_listar", "x-modulo": "estoque", "x-recurso": "relatorio_lotes", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — parte do nome do produto", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — parte do código do produto", "schema": { "type": "string" } }, { "name": "numero_lote", "in": "query", "required": false, "description": "string — parte do número do lote", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "vencido, vence_em_breve (vence nos próximos 30 dias), valido (vence depois de 30 dias) ou sem_validade", "schema": { "type": "string" } }, { "name": "fabricacao_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — fabricação a partir de", "schema": { "type": "string" } }, { "name": "fabricacao_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fabricação até", "schema": { "type": "string" } }, { "name": "validade_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — validade a partir de", "schema": { "type": "string" } }, { "name": "validade_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — validade até", "schema": { "type": "string" } }, { "name": "exibir_zerados", "in": "query", "required": false, "description": "1 = inclui lotes com saldo zero; sem ele só lotes com saldo", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "lotes": { "type": "integer" }, "quantidade": { "type": "integer" }, "vencidos": { "type": "integer" }, "vence_em_breve": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "numero_lote": { "type": "string" }, "loja": { "type": "string" }, "data_fabricacao": { "type": "string" }, "data_validade": { "type": "string" }, "quantidade_inicial": { "type": "integer" }, "quantidade": { "type": "integer" }, "situacao": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "lotes": 1, "quantidade": 12, "vencidos": 0, "vence_em_breve": 1 }, "itens": [ { "id": "1", "produto_id": "31998", "codigo": "2050460512009", "nome": "Coca cola", "numero_lote": "L-TESTE-API", "loja": "Master", "data_fabricacao": "2026-09-01", "data_validade": "2026-11-10", "quantidade_inicial": 20, "quantidade": 12, "situacao": "Vence em breve" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Sem período obrigatório: sem filtros traz todos os lotes ativos com saldo. 400 'Controle de lote não está habilitado' quer dizer que a empresa não usa lote (Configurações > Gerais > Estoque) — não é erro de filtro. 'Vence em breve' = validade nos próximos 30 dias contando hoje. data.totais.quantidade soma o saldo de todos os lotes listados; data.totais.vencidos e vence_em_breve contam lotes, não unidades. data.itens é só uma página: nunca some as linhas.", "description": "Lotes de produto com saldo, fabricação, validade e situação pela validade (vencido, vence em breve, válido, sem validade), com os totais. É a mesma regra do relatório de lotes da tela Estoque > Relatórios; só existe para empresa com o controle de lote ligado.\n\nSem permissão própria, como na tela: o relatório de lotes não tem ACO e o que libera é a configuração de controle de lote da empresa.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/produtos_comprados": { "get": { "tags": [ "Estoque e compras" ], "summary": "Consultar relatório de produtos comprados", "operationId": "estoque_relatorio_produtos_comprados_listar", "x-modulo": "estoque", "x-recurso": "relatorio_produtos_comprados", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão da compra)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — um produto", "schema": { "type": "string" } }, { "name": "grupo_id", "in": "query", "required": false, "description": "int — grupo de produtos (entram também os subgrupos); SG = produtos sem grupo", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — compras de um fornecedor", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação da compra (ids em /situacoes_compras)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo da compra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "total": { "type": "integer" }, "custo_total": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "grupo": { "type": [ "string", "null" ] }, "valor_custo_produto": { "type": "integer" }, "quantidade": { "type": "integer" }, "valor_custo": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_total": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto": { "type": "integer" }, "valor_custo_medio": { "type": "integer" }, "valor_venda_media": { "type": "number" }, "nome_final": { "type": "string" }, "quantidade_final": { "type": "integer" }, "valor_custo_final": { "type": "integer" }, "valor_total_final": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de emissão da compra", "inicio": "2025-11-01", "fim": "2026-10-26", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 25, "total": 212, "custo_total": 250 }, "itens": [ { "codigo": "2050460512009", "nome": "Coca cola", "grupo": null, "valor_custo_produto": 10, "quantidade": 25, "valor_custo": 250, "desconto_valor": 41, "desconto_porcentagem": 0, "valor_total": 212, "tipo_desconto": "R$", "desconto": 41, "valor_custo_medio": 10, "valor_venda_media": 8.480000000000000426325641456060111522674560546875, "nome_final": "Coca cola", "quantidade_final": 25, "valor_custo_final": 250, "valor_total_final": 212 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/ComprasProdutos/relatorio_produtos_comprados", "x-periodo": { "data": "a data de emissão da compra", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: responda quantidade (unidades compradas) e valor juntos e cite o período de meta.periodo. total é o valor pago nos itens (com desconto do item, sem frete); custo_total é quantidade × custo unitário lançado no item. Cada linha de data.itens é um produto (ou variação) agregado no período: valor_total e quantidade da linha, valor_venda_media = valor médio pago por unidade, valor_custo_medio = custo médio por unidade; valor_custo_produto é o custo ATUAL do cadastro do produto, não o da compra. data.itens é só uma página — nunca some as linhas. Só entram produtos: serviços contratados ficam fora. Sem situacao_id entram compras de todas as situações (inclusive cancelada). Usuário sem a permissão de ver compras de outros usuários só enxerga as que ele lançou. Compra não é venda nem estoque. Zerado: diga \"nenhum produto comprado no período, R$ 0,00\" e repita os filtros.", "description": "Produtos comprados no período, somados por produto (e variação), com a quantidade, o valor e o custo totais. É a mesma regra do relatório de produtos comprados da tela Compras > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da compra. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Compras/ComprasProdutos/relatorio_produtos_comprados` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/servicos_contratados": { "get": { "tags": [ "Estoque e compras" ], "summary": "Consultar relatório de serviços contratados", "operationId": "estoque_relatorio_servicos_contratados_listar", "x-modulo": "estoque", "x-recurso": "relatorio_servicos_contratados", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão da compra)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "servico_id", "in": "query", "required": false, "description": "int — um serviço (ids em /servicos)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — compras de um fornecedor", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação da compra (ids em /situacoes_compras)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo da compra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "total": { "type": "integer" }, "quantidade": { "type": "integer" }, "custo_total": { "type": "integer" }, "lucro_total": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "grupo": { "type": [ "string", "null" ] }, "valor_custo_produto": { "type": "integer" }, "quantidade": { "type": "integer" }, "valor_custo": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_total": { "type": "integer" }, "tipo_desconto": { "type": "string" }, "desconto": { "type": "string" }, "valor_custo_medio": { "type": "integer" }, "valor_venda_media": { "type": "integer" }, "nome_final": { "type": "string" }, "quantidade_final": { "type": "integer" }, "valor_custo_final": { "type": "integer" }, "valor_total_final": { "type": "integer" }, "valor_custo_calculado": { "type": "integer" }, "valor_venda_calculado": { "type": "integer" }, "lucro_calculado": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de emissão da compra", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": true }, "data": { "totais": { "total": 300, "quantidade": 2, "custo_total": 300, "lucro_total": 0 }, "itens": [ { "codigo": "2042423891504", "nome": "Hospedagem de sites", "grupo": null, "valor_custo_produto": 100, "quantidade": 2, "valor_custo": 300, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_total": 300, "tipo_desconto": "R$", "desconto": "------", "valor_custo_medio": 150, "valor_venda_media": 150, "nome_final": "Hospedagem de sites", "quantidade_final": 2, "valor_custo_final": 300, "valor_total_final": 300, "valor_custo_calculado": 150, "valor_venda_calculado": 150, "lucro_calculado": 0 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Compras/ComprasProdutos/relatorio_servicos_contratados", "x-periodo": { "data": "a data de emissão da compra", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: total é o valor pago nos itens de serviço (com desconto do item, sem frete), quantidade a soma das quantidades, custo_total = quantidade × custo lançado no item e lucro_total = total − custo_total. Responda total e quantidade juntos e cite o período de meta.periodo. Cada linha de data.itens é um serviço agregado no período; valor_custo_produto é o custo ATUAL do cadastro, não o da compra. data.itens é só uma página — nunca some as linhas. Só entram serviços: produtos comprados ficam em /relatorios/produtos_comprados. Sem situacao_id entram compras de todas as situações (inclusive cancelada). Compra não é venda. Zerado: diga \"nenhum serviço contratado no período, R$ 0,00\" e repita os filtros.", "description": "Serviços contratados (itens de serviço das compras) no período, somados por serviço, com a quantidade, o valor, o custo e o lucro totais. É a mesma regra do relatório de serviços contratados da tela Compras > Relatórios.\n\nUsuário sem a permissão Compras/ComprasProdutos/liberado_usuario só vê as compras que ele lançou.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da compra. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Compras/ComprasProdutos/relatorio_servicos_contratados` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/transferencias_estoques": { "get": { "tags": [ "Estoque e compras" ], "summary": "Listar transferências de estoque", "operationId": "estoque_transferencias_estoques_listar", "x-modulo": "estoque", "x-recurso": "transferencias_estoques", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da transferência)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número da transferência; com ele o período é ignorado", "schema": { "type": "string" } }, { "name": "loja_origem_id", "in": "query", "required": false, "description": "int — loja de origem (precisa ser uma loja que o usuário acessa)", "schema": { "type": "string" } }, { "name": "loja_destino_id", "in": "query", "required": false, "description": "int — loja de destino (precisa ser uma loja que o usuário acessa)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "transferencias": { "type": "integer" }, "valor_total": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "loja_origem_id": { "type": "string" }, "nome_loja_origem": { "type": "string" }, "loja_destino_id": { "type": "string" }, "nome_loja_destino": { "type": "string" }, "valor_total": { "type": "integer" }, "observacoes": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "nota_fiscal": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data da transferência", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "transferencias": 1, "valor_total": 30 }, "itens": [ { "id": "144", "codigo": "1", "loja_origem_id": "65", "nome_loja_origem": "Master", "loja_destino_id": "80764", "nome_loja_destino": "11", "valor_total": 30, "observacoes": "Teste local da API (GCK-22566)", "nome_usuario": "Teste API", "cadastrado_em": "2026-10-27 18:03:18", "nota_fiscal": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Estoque/TransferenciasEstoques/index", "x-periodo": { "data": "a data da transferência", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Entram as transferências em que a loja de origem OU a de destino é uma loja do usuário da chave (não há loja_id: use loja_origem_id/loja_destino_id; loja que o usuário não acessa é ignorada sem erro). Com codigo o período não é aplicado, mesmo que meta.periodo mostre o mês atual. data.totais.valor_total é o custo transferido e só vem para quem tem Produtos/visualizar_valor_custo. nota_fiscal é null quando a transferência não tem NF-e. data.itens é só uma página.", "description": "Transferências de estoque entre lojas (tela Estoque > Transferências), só leitura, com a NF-e de transferência vinculada quando houver. A listagem traz o período com os totais; o detalhe traz os produtos.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da transferência. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Estoque/TransferenciasEstoques/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/transferencias_estoques/{id}": { "get": { "tags": [ "Estoque e compras" ], "summary": "Visualizar transferências de estoque", "operationId": "estoque_transferencias_estoques_visualizar", "x-modulo": "estoque", "x-recurso": "transferencias_estoques", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "loja_origem_id": { "type": "string" }, "nome_loja_origem": { "type": "string" }, "loja_destino_id": { "type": "string" }, "nome_loja_destino": { "type": "string" }, "valor_total": { "type": "integer" }, "observacoes": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "nota_fiscal": { "type": [ "string", "null" ] }, "estado_destino": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "estoque_id": { "type": "string" }, "codigo": { "type": "string" }, "nome_produto": { "type": "string" }, "variacao": { "type": [ "string", "null" ] }, "unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_total": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "144", "codigo": "1", "loja_origem_id": "65", "nome_loja_origem": "Master", "loja_destino_id": "80764", "nome_loja_destino": "11", "valor_total": 30, "observacoes": "Teste local da API (GCK-22566)", "nome_usuario": "Teste API", "cadastrado_em": "2026-10-27 18:03:18", "nota_fiscal": null, "estado_destino": "MG", "produtos": [ { "id": "156", "produto_id": "31998", "estoque_id": "294470", "codigo": "2050460512009", "nome_produto": "Coca cola", "variacao": null, "unidade": "UN", "quantidade": 3, "valor_custo": 10, "valor_total": 30 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Estoque/TransferenciasEstoques/visualizar", "x-ia": "404 também quando nem a origem nem o destino são lojas do usuário da chave. estado_destino é a UF da loja de destino. valor_custo/valor_total só vêm com a permissão Produtos/visualizar_valor_custo.", "description": "**Permissão exigida:** `Estoque/TransferenciasEstoques/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/pagamentos": { "get": { "tags": [ "Financeiro" ], "summary": "Listar pagamentos", "operationId": "financeiro_pagamentos_listar", "x-modulo": "financeiro", "x-recurso": "pagamentos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período pela data de fluxo (vencimento; data da baixa quando baixado)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_inicio_emissao", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período pela data de competência (data_competencia); com ele data_inicio/data_fim são ignoradas. Mande junto com data_fim_emissao", "schema": { "type": "string" } }, { "name": "data_fim_emissao", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período por competência", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele vem só a loja padrão do usuário da chave (não todas as lojas)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número do pagamento que aparece na tela (não é o id); busca exata e ignora o período", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "texto — palavra do início da descrição do lançamento (não procura no nome do fornecedor: use fornecedor_id)", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora (ids em /transportadoras)", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — um funcionário (ids em /funcionarios)", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "número com ponto decimal (100.50) — valor_total mínimo; vírgula não funciona", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "número com ponto decimal — valor_total máximo", "schema": { "type": "string" } }, { "name": "liquidado", "in": "query", "required": false, "description": "ab = em aberto, at = em atraso (em aberto com data de fluxo antes de hoje), pg = confirmado (baixado); combina com o período. Outro valor é ignorado e vem tudo", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação do lançamento (o situacao_id vem nas linhas de /relatorios/contas_pagar; esta lista não traz a situação)", "schema": { "type": "string" } }, { "name": "plano_contas_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); plano pai inclui os filhos; com rateio, entra pelo plano do rateio", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos), próprio ou do rateio", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "venda", "in": "query", "required": false, "description": "int — id da venda (de /vendas): as parcelas dessa venda; ignora o período", "schema": { "type": "string" } }, { "name": "compra", "in": "query", "required": false, "description": "int — id da compra (de /compras): as parcelas dessa compra; ignora o período", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_da_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "409", "codigo": "3305", "descricao": "Compra de TV 33", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-25", "data_liquidacao": "2020-01-25", "data_competencia": "2020-01-25", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de fluxo (vencimento; a data da baixa quando a conta foi baixada)", "padrao": "mês atual", "teto_meses": 0 }, "x-ia": "Contas a pagar linha a linha, 20 por página (limite até 100; meta.total_registros é o total do recorte). Sem datas vem só o mês atual pela data de fluxo, e liquidado combina com o período: \"o que está vencido\" sem datas esconde os meses anteriores — mande data_inicio/data_fim (liquidado=at para só os atrasados). Sem limite de período. Número que o cliente cita (\"pagamento 682\") é o codigo, não o id: filtre por codigo (ignora o período) e use o id que voltar em /pagamentos/{id}. liquidado na resposta vem 1 = baixado (data_liquidacao = data da baixa) ou 0 = em aberto. Sem loja_id só a loja padrão da chave. Lista vazia vem com 200 e a mensagem \"Nenhuma movimentação foi encontrada!\". Para total do período use pagamentos_totais ou relatorio_contas_pagar, já somados — nunca some as linhas. Nunca some pagamento com recebimento: o único número que junta os dois é o saldo.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; a data da baixa quando a conta foi baixada). Sem elas: mês atual. Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Financeiro" ], "summary": "Cadastrar pagamentos", "operationId": "financeiro_pagamentos_cadastrar", "x-modulo": "financeiro", "x-recurso": "pagamentos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "409", "codigo": "3305", "descricao": "Compra de TV 33", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-25", "data_liquidacao": "2020-01-25", "data_competencia": "2020-01-25", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `descricao`, `data_vencimento`, `plano_contas_id`, `forma_pagamento_id`, `conta_bancaria_id`, `valor`, `data_competencia`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "descricao": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "valor_total": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "liquidado": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" } } }, "example": { "descricao": "Compra de TV 33", "data_vencimento": "2020-01-25", "valor": "1599.99", "juros": "2", "desconto": "1", "valor_total": "1598.99", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "cliente_id": "6", "nome_cliente": "Jarvis Stark", "liquidado": "1", "data_liquidacao": "2020-01-25", "data_competencia": "2020-01-25", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos" } } } } } }, "/pagamentos/{id}": { "get": { "tags": [ "Financeiro" ], "summary": "Visualizar pagamentos", "operationId": "financeiro_pagamentos_visualizar", "x-modulo": "financeiro", "x-recurso": "pagamentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "409", "codigo": "3305", "descricao": "Compra de TV 33", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-25", "data_liquidacao": "2020-01-25", "data_competencia": "2020-01-25", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "O id é o interno (vem na listagem), não o codigo da tela: para \"o pagamento 682\" busque antes /pagamentos?codigo=682. Id de recebimento aqui é 404 com o caminho certo (/recebimentos/{id}). liquidado 1 = baixado, com a data em data_liquidacao; 0 = em aberto. rateios traz a divisão por plano de contas e centro de custo quando o lançamento é rateado. Não traz situação nem link de boleto/pagamento.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Financeiro" ], "summary": "Editar pagamentos", "operationId": "financeiro_pagamentos_editar", "x-modulo": "financeiro", "x-recurso": "pagamentos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "388", "codigo": "3284", "descricao": "Compra de TV 32 Polegadas", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-29", "data_liquidacao": "2020-01-29", "data_competencia": "2020-01-29", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `descricao`, `data_vencimento`, `plano_contas_id`, `forma_pagamento_id`, `conta_bancaria_id`, `valor`, `data_competencia`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "descricao": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "valor_total": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "liquidado": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" } } }, "example": { "descricao": "Compra de TV 32 Polegadas", "data_vencimento": "2020-01-29", "valor": "1599.99", "juros": "2", "desconto": "1", "valor_total": "1598.99", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "cliente_id": "6", "nome_cliente": "Jarvis Stark", "liquidado": "1", "data_liquidacao": "2020-01-29", "data_competencia": "2020-01-29", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos" } } } } }, "delete": { "tags": [ "Financeiro" ], "summary": "Deletar pagamentos", "operationId": "financeiro_pagamentos_deletar", "x-modulo": "financeiro", "x-recurso": "pagamentos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Movimentação removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/pagamentos/{id}/historico": { "get": { "tags": [ "Financeiro" ], "summary": "Histórico de pagamentos", "operationId": "financeiro_pagamentos_historico", "x-modulo": "financeiro", "x-recurso": "pagamentos", "x-operacao": "historico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "movimentacao_id": { "type": "string" }, "tipo": { "type": "string" }, "quantidade": { "type": "integer" }, "eventos": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string" }, "tipo": { "type": "string" }, "descricao": { "type": "string" }, "nome_usuario": { "type": "string" }, "situacao": { "type": [ "string", "null" ] }, "detalhe": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "movimentacao_id": "133623425", "tipo": "D", "quantidade": 2, "eventos": [ { "data": "2026-10-27 15:03:06", "tipo": "criacao", "descricao": "A cobrança foi criada e registrada no sistema", "nome_usuario": "João do BD COMPARTILHADO!", "situacao": null, "detalhe": null }, { "data": "2026-10-27", "tipo": "baixa", "descricao": "A cobrança foi quitada e teve sua baixa registrada", "nome_usuario": "João do BD COMPARTILHADO!", "situacao": null, "detalhe": "Confirmada por João do BD COMPARTILHADO!" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_pagamento", "x-ia": "Use para \"quando esta conta foi paga/recebida e por quem\" ou \"quem mudou a situação\". data.eventos vem em ordem cronológica (a criação sempre primeiro); tipo é criacao, vencimento, situacao ou baixa. O evento de vencimento futuro tem data no futuro (ainda não aconteceu). detalhe diz quem confirmou a baixa e por onde (tela, banco integrado, conciliação, forma de pagamento automática) e a observação digitada. Lançamento de loja que o usuário da chave não acessa — ou, sem a permissão liberado_usuario, de outro usuário — é 404. Os envios da cobrança ao cliente não entram aqui: use /relatorios/envios_cobranca?movimentacao_id={id}.", "description": "Linha do tempo do pagamento, em ordem cronológica: criação, vencimento, mudanças de situação e baixa (com quem confirmou e por onde). É a mesma regra da aba Histórico da visualização do lançamento. O id tem de ser de um pagamento — id de recebimento aqui é 404 com o caminho certo.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_pagamento` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/recebimentos": { "get": { "tags": [ "Financeiro" ], "summary": "Listar recebimentos", "operationId": "financeiro_recebimentos_listar", "x-modulo": "financeiro", "x-recurso": "recebimentos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período pela data de fluxo (vencimento; data da baixa quando baixado)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_inicio_emissao", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período pela data de competência (data_competencia); com ele data_inicio/data_fim são ignoradas. Mande junto com data_fim_emissao", "schema": { "type": "string" } }, { "name": "data_fim_emissao", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período por competência", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele vem só a loja padrão do usuário da chave (não todas as lojas)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número do recebimento que aparece na tela (não é o id); busca exata e ignora o período", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "texto — palavra do início da descrição do lançamento (não procura no nome do cliente: use cliente_id)", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora (ids em /transportadoras)", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — um funcionário (ids em /funcionarios)", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "número com ponto decimal (100.50) — valor_total mínimo; vírgula não funciona", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "número com ponto decimal — valor_total máximo", "schema": { "type": "string" } }, { "name": "liquidado", "in": "query", "required": false, "description": "ab = em aberto, at = em atraso (em aberto com data de fluxo antes de hoje), pg = confirmado (baixado); combina com o período. Outro valor é ignorado e vem tudo", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação do lançamento (o situacao_id vem nas linhas de /relatorios/contas_receber; esta lista não traz a situação)", "schema": { "type": "string" } }, { "name": "plano_contas_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); plano pai inclui os filhos; com rateio, entra pelo plano do rateio", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos), próprio ou do rateio", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "venda", "in": "query", "required": false, "description": "int — id da venda (de /vendas): as parcelas dessa venda; ignora o período", "schema": { "type": "string" } }, { "name": "contrato", "in": "query", "required": false, "description": "int — id do contrato (de /contratos_servicos): as parcelas desse contrato; ignora o período", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "int — o mesmo que limite: registros por página (padrão 20, máximo 100)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "410", "codigo": "3306", "descricao": "venda de TV 44", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-30", "data_liquidacao": "2020-01-30", "data_competencia": "2020-01-30", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de fluxo (vencimento; a data da baixa quando a conta foi baixada)", "padrao": "mês atual", "teto_meses": 0 }, "x-ia": "Contas a receber linha a linha, 20 por página (limite até 100; meta.total_registros é o total do recorte). Sem datas vem só o mês atual pela data de fluxo, e liquidado combina com o período: \"o que está vencido\" sem datas esconde os meses anteriores — mande data_inicio/data_fim (liquidado=at para só os atrasados). Sem limite de período. Número que o cliente cita (\"recebimento 682\") é o codigo, não o id: filtre por codigo (ignora o período) e use o id que voltar em /recebimentos/{id}. liquidado na resposta vem 1 = baixado (data_liquidacao = data da baixa) ou 0 = em aberto. Sem loja_id só a loja padrão da chave. Lista vazia vem com 200 e a mensagem \"Nenhuma movimentação foi encontrada!\". Para total do período use recebimentos_totais ou relatorio_contas_receber, já somados — nunca some as linhas. Nunca some recebimento com pagamento: o único número que junta os dois é o saldo.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; a data da baixa quando a conta foi baixada). Sem elas: mês atual. Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Financeiro" ], "summary": "Cadastrar recebimentos", "operationId": "financeiro_recebimentos_cadastrar", "x-modulo": "financeiro", "x-recurso": "recebimentos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "410", "codigo": "3306", "descricao": "venda de TV 44", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-30", "data_liquidacao": "2020-01-30", "data_competencia": "2020-01-30", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `descricao`, `data_vencimento`, `plano_contas_id`, `forma_pagamento_id`, `conta_bancaria_id`, `valor`, `data_competencia`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "descricao": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "valor_total": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "liquidado": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" } } }, "example": { "descricao": "venda de TV 44", "data_vencimento": "2020-01-30", "valor": "1599.99", "juros": "2", "desconto": "1", "valor_total": "1598.99", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "cliente_id": "6", "nome_cliente": "Jarvis Stark", "liquidado": "1", "data_liquidacao": "2020-01-30", "data_competencia": "2020-01-30", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos" } } } } } }, "/recebimentos/{id}": { "get": { "tags": [ "Financeiro" ], "summary": "Visualizar recebimentos", "operationId": "financeiro_recebimentos_visualizar", "x-modulo": "financeiro", "x-recurso": "recebimentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "410", "codigo": "3306", "descricao": "venda de TV 44", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-30", "data_liquidacao": "2020-01-30", "data_competencia": "2020-01-30", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "O id é o interno (vem na listagem), não o codigo da tela: para \"o recebimento 682\" busque antes /recebimentos?codigo=682. Id de pagamento aqui é 404 com o caminho certo (/pagamentos/{id}). liquidado 1 = baixado, com a data em data_liquidacao; 0 = em aberto. rateios traz a divisão por plano de contas e centro de custo quando o lançamento é rateado. Não traz situação nem link de boleto/pagamento.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Financeiro" ], "summary": "Editar recebimentos", "operationId": "financeiro_recebimentos_editar", "x-modulo": "financeiro", "x-recurso": "recebimentos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "taxa_banco": { "type": "string" }, "taxa_operadora": { "type": "string" }, "valor_total": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "liquidado": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "410", "codigo": "3306", "descricao": "venda de TV 44 POLEGADAS", "valor": "1599.99", "juros": "2.00", "desconto": "1.00", "taxa_banco": "0.00", "taxa_operadora": "0.00", "valor_total": "1600.99", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "fornecedor_id": null, "nome_fornecedor": null, "cliente_id": "6", "nome_cliente": "Jarvis Stark", "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "liquidado": "1", "data_vencimento": "2020-01-31", "data_liquidacao": "2020-01-31", "data_competencia": "2020-01-31", "usuario_id": "45", "nome_usuario": "João da Silva", "loja_id": "65", "nome_loja": "Savassi" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `descricao`, `data_vencimento`, `plano_contas_id`, `forma_pagamento_id`, `conta_bancaria_id`, `valor`, `data_competencia`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "descricao": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "juros": { "type": "string" }, "desconto": { "type": "string" }, "valor_total": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "liquidado": { "type": "string" }, "data_liquidacao": { "type": "string" }, "data_competencia": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" } } }, "example": { "descricao": "venda de TV 44 POLEGADAS", "data_vencimento": "2020-01-31", "valor": "1599.99", "juros": "2", "desconto": "1", "valor_total": "1598.99", "centro_custo_id": "1", "nome_centro_custo": "Centro de Custo 01", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "forma_pagamento_id": "640517", "nome_forma_pagamento": "Dinheiro à Vista", "entidade": "C", "cliente_id": "6", "nome_cliente": "Jarvis Stark", "liquidado": "1", "data_liquidacao": "2020-01-31", "data_competencia": "2020-01-31", "plano_contas_id": "2512", "nome_plano_conta": "Vendas de produtos" } } } } }, "delete": { "tags": [ "Financeiro" ], "summary": "Deletar recebimentos", "operationId": "financeiro_recebimentos_deletar", "x-modulo": "financeiro", "x-recurso": "recebimentos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Movimentação removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/recebimentos/{id}/historico": { "get": { "tags": [ "Financeiro" ], "summary": "Histórico de recebimentos", "operationId": "financeiro_recebimentos_historico", "x-modulo": "financeiro", "x-recurso": "recebimentos", "x-operacao": "historico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "movimentacao_id": { "type": "string" }, "tipo": { "type": "string" }, "quantidade": { "type": "integer" }, "eventos": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string" }, "tipo": { "type": "string" }, "descricao": { "type": "string" }, "nome_usuario": { "type": "string" }, "situacao": { "type": [ "string", "null" ] }, "detalhe": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "movimentacao_id": "133623423", "tipo": "C", "quantidade": 2, "eventos": [ { "data": "2026-10-27 15:01:10", "tipo": "criacao", "descricao": "A cobrança foi criada e registrada no sistema", "nome_usuario": "João do BD COMPARTILHADO!", "situacao": null, "detalhe": null }, { "data": "2026-10-20", "tipo": "vencimento", "descricao": "A cobrança atingiu o prazo de vencimento", "nome_usuario": "João do BD COMPARTILHADO!", "situacao": null, "detalhe": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_recebimento", "x-ia": "Use para \"quando esta conta foi paga/recebida e por quem\" ou \"quem mudou a situação\". data.eventos vem em ordem cronológica (a criação sempre primeiro); tipo é criacao, vencimento, situacao ou baixa. O evento de vencimento futuro tem data no futuro (ainda não aconteceu). detalhe diz quem confirmou a baixa e por onde (tela, banco integrado, conciliação, forma de pagamento automática) e a observação digitada. Lançamento de loja que o usuário da chave não acessa — ou, sem a permissão liberado_usuario, de outro usuário — é 404. Os envios da cobrança ao cliente não entram aqui: use /relatorios/envios_cobranca?movimentacao_id={id}.", "description": "Linha do tempo do recebimento, em ordem cronológica: criação, vencimento, mudanças de situação e baixa (com quem confirmou e por onde). É a mesma regra da aba Histórico da visualização do lançamento. O id tem de ser de um recebimento — id de pagamento aqui é 404 com o caminho certo.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_recebimento` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_financeiros": { "get": { "tags": [ "Financeiro" ], "summary": "Listar campos extras financeiros", "operationId": "financeiro_atributos_financeiros_listar", "x-modulo": "financeiro", "x-recurso": "atributos_financeiros", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "texto — trecho do nome do campo extra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Registro", "tipo": "numeros", "modificado_em": "2025-01-21 00:58:11", "cadastrado_em": "2025-01-21 00:58:11" }, { "id": "2", "nome": "Campo Aux", "tipo": "texto_simples", "modificado_em": "2025-01-21 00:58:36", "cadastrado_em": "2025-01-21 00:58:36" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Campos extras que a empresa criou para os lançamentos financeiros (nome, tipo, obrigatorio). Não são valores de lançamento: o conteúdo de cada campo vem em atributos de /recebimentos/{id} e /pagamentos/{id}. Empresa sem campo extra (ou busca sem resultado) vem com 200, data vazia e a mensagem \"Nenhum campo extra foi encontrado!\".", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Financeiro" ], "summary": "Cadastrar campos extras financeiros", "operationId": "financeiro_atributos_financeiros_cadastrar", "x-modulo": "financeiro", "x-recurso": "atributos_financeiros", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo": { "type": "string" }, "nome": { "type": "string" }, "empresa_id": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "tipo": "check_list", "nome": "Comprovante", "empresa_id": "75798", "permitir_excluir": "1", "usuario_id": "131036", "nome_usuario": "Controle 1", "cadastrado_em": "2025-04-14 17:47:04", "modificado_em": "2025-04-14 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "PIX" }, { "id": "2", "atributo_id": "5", "nome": "Boleto" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Comprovante", "tipo": "check_list", "opcoes": [ { "nome": "PIX" }, { "nome": "Boleto" } ] } } } } } }, "/atributos_financeiros/{id}": { "get": { "tags": [ "Financeiro" ], "summary": "Visualizar campos extras financeiros", "operationId": "financeiro_atributos_financeiros_visualizar", "x-modulo": "financeiro", "x-recurso": "atributos_financeiros", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo": { "type": "string" }, "empresa_id": { "type": "string" }, "permitir_excluir": { "type": "string" }, "nome": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "tipo": "check_list", "empresa_id": "75798", "permitir_excluir": "1", "nome": "Documento", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "CPF" }, { "id": "2", "atributo_id": "5", "nome": "CNH" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Financeiro" ], "summary": "Editar campos extras financeiros", "operationId": "financeiro_atributos_financeiros_editar", "x-modulo": "financeiro", "x-recurso": "atributos_financeiros", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "tipo": { "type": "string" }, "nome": { "type": "string" }, "empresa_id": { "type": "string" }, "permitir_excluir": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "atributo_id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1", "tipo": "check_list", "nome": "Documentos", "empresa_id": "75798", "permitir_excluir": "1", "usuario_id": "1", "nome_usuario": "Usuario", "cadastrado_em": "2025-04-15 17:47:04", "modificado_em": "2025-04-15 17:47:04", "opcoes": [ { "id": "1", "atributo_id": "5", "nome": "PIX" }, { "id": "2", "atributo_id": "5", "nome": "Boleto" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo`: texto_simples, numeros, data, cpf, cnpj, check_list ou selecao_multipla (outro valor é 400). `opcoes` (lista de textos) só é exigido em check_list e selecao_multipla; nos outros tipos pode ser omitido.\n\n**Campos obrigatórios:** `nome`, `tipo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" } } } } } }, "example": { "nome": "Documentos", "tipo": "check_list", "opcoes": [ { "nome": "PIX" }, { "nome": "Boleto" } ] } } } } }, "delete": { "tags": [ "Financeiro" ], "summary": "Deletar campos extras financeiros", "operationId": "financeiro_atributos_financeiros_deletar", "x-modulo": "financeiro", "x-recurso": "atributos_financeiros", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": "Campo extra removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/formas_pagamentos": { "get": { "tags": [ "Financeiro" ], "summary": "Listar formas pagamentos", "operationId": "financeiro_formas_pagamentos_listar", "x-modulo": "financeiro", "x-recurso": "formas_pagamentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "texto — trecho do nome da forma de pagamento", "schema": { "type": "string" } }, { "name": "banco", "in": "query", "required": false, "description": "texto — só as formas de uma integração (o valor do campo banco, ex.: bb, asaas)", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — com mais de uma loja, as formas cuja conta bancária é desta loja; sem ele, as da loja padrão do usuário da chave", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "maximo_parcelas": { "type": "string" }, "intervalo_parcelas": { "type": "string" }, "intervalo_primeira_parcela": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_da_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "640517", "nome": "Dinheiro à Vista", "conta_bancaria_id": "1", "nome_conta_bancaria": "Conta padrão", "maximo_parcelas": "1", "intervalo_parcelas": "0", "intervalo_primeira_parcela": "0" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Formas de pagamento cadastradas. Cada item vem dentro de FormasPagamento (data[].FormasPagamento.id, .nome). movimentacao: C = só contas a receber, D = só contas a pagar, CD = as duas. tipo é o meio de pagamento: DI dinheiro, CC cartão de crédito, CD cartão de débito, PI Pix, BB boleto, CH cheque, DP duplicata, CA carnê, TB transferência, OU outros. boleto = 1 é forma que emite boleto; conta_bancaria_id/nome_conta_bancaria é a conta onde cai. Use para achar o forma_pagamento_id dos filtros. Busca sem resultado vem com 200, data vazia e a mensagem \"Não há dados!\".", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/contas_bancarias": { "get": { "tags": [ "Financeiro" ], "summary": "Listar contas bancárias", "operationId": "financeiro_contas_bancarias_listar", "x-modulo": "financeiro", "x-recurso": "contas_bancarias", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "texto — trecho do nome da conta", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — com mais de uma loja, as contas ligadas a esta loja; sem ele, as da loja padrão do usuário da chave", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_da_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Conta padrão" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Cadastro de contas bancárias: só id e nome, sem saldo, banco, agência ou número. Use para achar o conta_bancaria_id dos filtros. Para o saldo de cada conta use /contas_bancarias/painel (realizado) ou /relatorios/contas_bancarias (projetado). Caixa (dinheiro do PDV) não é conta bancária: está em /caixas. Busca sem resultado vem com 200, data vazia e a mensagem \"Não há dados!\".", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/planos_contas": { "get": { "tags": [ "Financeiro" ], "summary": "Listar planos de contas", "operationId": "financeiro_planos_contas_listar", "x-modulo": "financeiro", "x-recurso": "planos_contas", "x-operacao": "listar", "parameters": [ { "name": "tipo", "in": "query", "required": false, "description": "C = receitas (planos de recebimento), D = despesas (planos de pagamento); outro valor é ignorado e vem tudo", "schema": { "type": "string" } }, { "name": "busca", "in": "query", "required": false, "description": "texto — trecho do nome ou da classificação (ex.: 1.1)", "schema": { "type": "string" } }, { "name": "todos", "in": "query", "required": false, "description": "1 = inclui as contas-mãe (os grupos, sem conta_mae_id); sem ele só vêm os planos que recebem lançamento", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "conta_mae_id": { "type": "string" }, "classificacao": { "type": "string" }, "tipo": { "type": "string" }, "nome": { "type": "string" }, "nome_tipo": { "type": "string" }, "nome_conta_mae": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 4, "total_da_pagina": 4, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "4878064", "conta_mae_id": "4655131", "classificacao": "1.1.1", "tipo": "D", "nome": "Plano Padrão 01", "nome_tipo": "Pagamentos", "nome_conta_mae": "Despesas administrativas e comerciais" }, { "id": "4878060", "conta_mae_id": "4655131", "classificacao": "1.2.1", "tipo": "D", "nome": "Aluguel", "nome_tipo": "Pagamentos", "nome_conta_mae": "Despesas administrativas e comerciais" }, { "id": "4878062", "conta_mae_id": "4655131", "classificacao": "2.1.1", "tipo": "C", "nome": "Teste 2", "nome_tipo": "Pagamentos", "nome_conta_mae": "Despesas administrativas e comerciais" }, { "id": "4878063", "conta_mae_id": "4655131", "classificacao": "2.1.2", "tipo": "C", "nome": "Teste 12", "nome_tipo": "Pagamentos", "nome_conta_mae": "Despesas administrativas e comerciais" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Plano de contas da empresa (as categorias de receita e despesa), na ordem da tela; não tem período nem loja. classificacao é a numeração (1.1.1) e conta_mae_id/nome_conta_mae dizem o grupo. Use para achar o plano_contas_id de /recebimentos e /pagamentos (nos relatórios o mesmo id vai em categoria_id). Não traz valores: quanto entrou ou saiu por plano sai de /relatorios/plano_contas. Sem todos=1 os grupos (contas-mãe) não aparecem, mas filtrar por um grupo nas listagens inclui os filhos.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/centros_custos": { "get": { "tags": [ "Financeiro" ], "summary": "Listar centros de custos", "operationId": "financeiro_centros_custos_listar", "x-modulo": "financeiro", "x-recurso": "centros_custos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "texto — trecho do nome do centro de custo", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_da_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "total_da_pagina": 1, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1", "nome": "Centro de Custo 01", "cadastrado_em": "2020-01-21 10:07:18" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Cadastro de centros de custo da empresa (id, nome), em ordem de nome; não tem período nem loja. Use para achar o centro_custo_id dos filtros de /recebimentos, /pagamentos e dos relatórios. Não traz valores: o gasto por centro de custo sai de /relatorios/centros_custos. Busca sem resultado vem com 200, data vazia e a mensagem \"Não há dados!\".", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/boletos": { "get": { "tags": [ "Financeiro" ], "summary": "Listar boletos bancários", "operationId": "financeiro_boletos_listar", "x-modulo": "financeiro", "x-recurso": "boletos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação personalizada do recebimento (o situacao_id vem nas linhas deste relatório e de /relatorios/contas_receber)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = recebido; sem ele entram todos", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); categoria pai inclui as filhas; com rateio, só a parte rateada", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número do recebimento que o cliente vê (não é o id); ignora o período", "schema": { "type": "string" } }, { "name": "numero_boleto", "in": "query", "required": false, "description": "int — número do boleto (coluna Boleto da tela)", "schema": { "type": "string" } }, { "name": "busca", "in": "query", "required": false, "description": "texto — trecho da descrição do lançamento (não procura no nome do cliente: para filtrar por cliente use cliente_id)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valor_total": { "type": "number" }, "valor_recebido": { "type": "number" }, "valor_em_aberto": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "numero_boleto": { "type": "string" }, "identificacao_parcela": { "type": [ "string", "null" ] }, "entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "valor_total": { "type": "number" }, "data_fluxo": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_boleto": { "type": "string" }, "data_emissao": { "type": "string" }, "data_baixa": { "type": "string" }, "baixado": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "nome_categoria": { "type": "string" }, "nome_centro_custo": { "type": [ "string", "null" ] }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "pedido_id": { "type": [ "string", "null" ] }, "contrato_id": { "type": [ "string", "null" ] }, "servico_id": { "type": [ "string", "null" ] }, "locacao_id": { "type": [ "string", "null" ] }, "nota_fiscal_id": { "type": [ "string", "null" ] }, "nota_fiscal_servico_id": { "type": [ "string", "null" ] }, "descricao": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "pix": { "type": "boolean" }, "remessa": { "type": "object", "properties": { "situacao": { "type": "integer" }, "data": { "type": [ "string", "null" ] }, "integradora": { "type": "string" }, "descricao": { "type": "string" }, "erro": { "type": [ "string", "null" ] } } }, "ultimo_envio": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 2, "valor_total": 470.5, "valor_recebido": 120.5, "valor_em_aberto": 350 }, "itens": [ { "id": "133623424", "codigo": "3275", "numero_boleto": "2", "identificacao_parcela": null, "entidade": "C", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "fornecedor_id": null, "nome_fornecedor": null, "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "valor_total": 120.5, "data_fluxo": "2026-10-11", "data_vencimento": "2026-10-10", "data_boleto": "2026-10-10", "data_emissao": "2026-10-10", "data_baixa": "2026-10-11", "baixado": "1", "situacao_id": "281", "nome_forma_pagamento": "Boleto TESTE API", "nome_conta_bancaria": "Caixa", "nome_categoria": "Receitas TESTE SR", "nome_centro_custo": null, "loja_id": "65", "nome_loja": "Master", "pedido_id": null, "contrato_id": null, "servico_id": null, "locacao_id": null, "nota_fiscal_id": null, "nota_fiscal_servico_id": null, "descricao": "Boleto TESTE API recebido", "forma_pagamento_id": "646924", "pix": false, "remessa": { "situacao": 1, "data": null, "integradora": "Banco do Brasil", "descricao": "Remessa do Banco do Brasil gerada", "erro": null }, "ultimo_envio": null }, { "id": "133623423", "codigo": "3274", "numero_boleto": "1", "identificacao_parcela": null, "entidade": "C", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "fornecedor_id": null, "nome_fornecedor": null, "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "valor_total": 350, "data_fluxo": "2026-10-20", "data_vencimento": "2026-10-20", "data_boleto": "2026-10-20", "data_emissao": "2026-10-20", "data_baixa": null, "baixado": "0", "situacao_id": "280", "nome_forma_pagamento": "Boleto TESTE API", "nome_conta_bancaria": "Caixa", "nome_categoria": "Receitas TESTE SR", "nome_centro_custo": null, "loja_id": "65", "nome_loja": "Master", "pedido_id": null, "contrato_id": null, "servico_id": null, "locacao_id": null, "nota_fiscal_id": null, "nota_fiscal_servico_id": null, "descricao": "Boleto TESTE API aberto", "forma_pagamento_id": "646924", "pix": false, "remessa": { "situacao": 0, "data": null, "integradora": "Banco do Brasil", "descricao": "Remessa do Banco do Brasil não gerada", "erro": null }, "ultimo_envio": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/boletos_bancarios", "x-periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais vêm somados em data.totais para o período inteiro: quantidade de boletos, valor_total = valor_recebido + valor_em_aberto. Em aberto inclui vencido e a vencer — para só os vencidos use baixado=at. Boleto aqui é a conta a receber; a lista NÃO traz linha digitável, código de barras nem link do boleto (a tela também não mostra) — para segunda via oriente a imprimir pela tela. remessa.situacao: 0 = não gerada no banco/integradora, 1 = gerada (recebido conta como gerada), 2 = erro ao gerar (motivo em remessa.erro). ultimo_envio diz se e por onde o boleto foi mandado ao cliente (canal email/whatsapp/sms, situacao, datas); null = nunca enviado. data.itens é só uma página — nunca some as linhas. codigo e id são diferentes.", "description": "Boletos do período — contas a receber com forma de pagamento boleto ou com remessa gerada — com cliente, valor, vencimento, situação, remessa no banco/integradora e último envio ao cliente, e os totais somados. É a mesma regra da tela Financeiro > Boletos bancários. Só leitura: gerar, imprimir e enviar boleto, remessa e retorno ficam na tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; data da baixa quando baixado). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/boletos_bancarios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/caixas": { "get": { "tags": [ "Financeiro" ], "summary": "Listar caixas", "operationId": "financeiro_caixas_listar", "x-modulo": "financeiro", "x-recurso": "caixas", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (abertura ou fechamento)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — funcionário dono do caixa (ids em /usuarios). Sem a permissão Financeiro/Caixas/liberado_usuario o usuário da chave só vê os próprios caixas e este filtro não amplia isso", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "A = aberto, F = fechado; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "abertos": { "type": "integer" }, "fechados": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "situacao": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "data_hora_abertura": { "type": "string" }, "data_hora_fechamento": { "type": [ "string", "null" ] }, "saldo": { "type": "integer" }, "situacao_descricao": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de abertura ou a de fechamento do caixa", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 4, "pagina": 1, "limite": 2, "total_paginas": 2, "cache": false }, "data": { "totais": { "quantidade": 4, "abertos": 4, "fechados": 0 }, "itens": [ { "id": "322", "situacao": "A", "loja_id": "80764", "nome_loja": "11", "usuario_id": "130854", "nome_usuario": "Usuário", "data_hora_abertura": "2026-09-21 10:03:15", "data_hora_fechamento": null, "saldo": 230, "situacao_descricao": "Aberto" }, { "id": "321", "situacao": "A", "loja_id": "65", "nome_loja": "Master", "usuario_id": "130854", "nome_usuario": "Usuário", "data_hora_abertura": "2026-09-21 09:59:45", "data_hora_fechamento": null, "saldo": 10, "situacao_descricao": "Aberto" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/Caixas/index", "x-periodo": { "data": "a data de abertura ou a de fechamento do caixa (entra o caixa aberto ou fechado a partir de data_inicio e aberto ou fechado até data_fim)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Lista de caixas, não de vendas: cada item é um turno de caixa de um funcionário numa loja. saldo é o dinheiro apurado no caixa (lançamentos baixados em formas à vista, entradas menos saídas, fora o lançamento de fechamento); num caixa fechado é o saldo do fechamento. Caixa aberto antes de data_inicio e ainda aberto NÃO entra no período — para \"quais caixas estão abertos agora\" use situacao=A com um período que cubra a abertura. data.totais conta caixas do período inteiro (quantidade, abertos, fechados); data.itens é só uma página — nunca some as linhas. Para o detalhe por forma de pagamento use /caixas/{id}.", "description": "Caixas (PDV e Financeiro > Caixas) abertos ou fechados no período, com funcionário, loja, abertura, fechamento e saldo; e o detalhe de um caixa com o resumo por forma de pagamento, as movimentações por categoria e a conferência do fechamento. É a mesma regra da tela de caixas. Só leitura: abrir, fechar, sangria e reforço ficam na tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de abertura ou a de fechamento do caixa (entra o caixa aberto ou fechado a partir de data_inicio e aberto ou fechado até data_fim). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/Caixas/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/caixas/{id}": { "get": { "tags": [ "Financeiro" ], "summary": "Visualizar caixas", "operationId": "financeiro_caixas_visualizar", "x-modulo": "financeiro", "x-recurso": "caixas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "situacao": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "data_hora_abertura": { "type": "string" }, "data_hora_fechamento": { "type": [ "string", "null" ] }, "saldo": { "type": "integer" }, "situacao_descricao": { "type": "string" }, "cadastrado_por": { "type": "string" }, "cadastrado_em": { "type": "string" }, "totais": { "type": "object", "properties": { "nao_baixado": { "type": "integer" }, "baixado": { "type": "integer" }, "total": { "type": "integer" } } }, "formas_pagamento": { "type": "array", "items": { "type": "object", "properties": { "forma_pagamento_id": { "type": "string" }, "nome": { "type": "string" }, "nao_baixado": { "type": "integer" }, "baixado": { "type": "integer" }, "total": { "type": "integer" } } } }, "movimentacoes": { "type": "array", "items": { "type": "object", "properties": { "tipo": { "type": "string" }, "movimento": { "type": "string" }, "categoria": { "type": "string" }, "formas_pagamento": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "baixado": { "type": "integer" }, "nao_baixado": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "conferencia": { "type": "object", "properties": { "houve_conferencia": { "type": "boolean" }, "totais": { "type": [ "string", "null" ] }, "formas_pagamento": { "type": "object", "properties": [] } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "322", "situacao": "A", "loja_id": "80764", "nome_loja": "11", "usuario_id": "130854", "nome_usuario": "Usuário", "data_hora_abertura": "2026-09-21 10:03:15", "data_hora_fechamento": null, "saldo": 230, "situacao_descricao": "Aberto", "cadastrado_por": "Usuário", "cadastrado_em": "2026-09-21 10:03:15", "totais": { "nao_baixado": 0, "baixado": 230, "total": 230 }, "formas_pagamento": [ { "forma_pagamento_id": "646904", "nome": "Dinheiro à Vista", "nao_baixado": 0, "baixado": 230, "total": 230 } ], "movimentacoes": [ { "tipo": "C", "movimento": "entrada", "categoria": "Vendas de produtos", "formas_pagamento": [ { "nome": "Dinheiro à Vista", "baixado": 215, "nao_baixado": 0, "total": 215 } ] }, { "tipo": "C", "movimento": "entrada", "categoria": "Vendas realizadas no balcão", "formas_pagamento": [ { "nome": "Dinheiro à Vista", "baixado": 15, "nao_baixado": 0, "total": 15 } ] } ], "conferencia": { "houve_conferencia": false, "totais": null, "formas_pagamento": [] } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/Caixas/visualizar", "x-ia": "Detalhe de um caixa das lojas do usuário da chave (404 se for de outra loja). formas_pagamento soma tudo o que passou pelo caixa por forma: baixado (pago/recebido), nao_baixado e total, com saídas negativas; totais é a soma dessas linhas. movimentacoes quebra por tipo (C/NC entrada, D/ND saída — NC/ND são movimentos só do caixa, sem lançamento no financeiro — ex.: abertura, sangria e reforço com \"lançar no financeiro\" desligado) e categoria, com valores sem sinal: o sentido está em movimento. saldo é o dinheiro em formas à vista (o mesmo da lista), não o total de formas_pagamento, que inclui cartão, Pix e prazo. conferencia só existe quando o fechamento foi conferido (houve_conferencia): valor_sistema é o apurado, valor_informado o contado pelo operador e diferenca = informado − sistema.", "description": "**Permissão exigida:** `Financeiro/Caixas/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/categorias_dre": { "get": { "tags": [ "Financeiro" ], "summary": "Listar grupos do DRE", "operationId": "financeiro_categorias_dre_listar", "x-modulo": "financeiro", "x-recurso": "categorias_dre", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome; traz os grupos que casam e os grupos-pai dos subgrupos que casam (com só os subgrupos que casam)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página da lista de grupos em data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — grupos por página (padrão e máximo 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade_grupos": { "type": "integer" }, "quantidade_subgrupos": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "nome_tipo": { "type": "string" }, "ativo": { "type": "integer" }, "padrao": { "type": "integer" }, "subgrupos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "nome_tipo": { "type": "string" }, "ativo": { "type": "integer" }, "padrao": { "type": "integer" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 11, "pagina": 1, "limite": 3, "total_paginas": 4, "cache": false }, "data": { "totais": { "quantidade_grupos": 11, "quantidade_subgrupos": 15 }, "itens": [ { "id": "1340", "nome": "Receita bruta", "tipo": "+", "nome_tipo": "Receita", "ativo": 1, "padrao": 0, "subgrupos": [ { "id": "1341", "nome": "Receitas de vendas", "tipo": "+", "nome_tipo": "Receita", "ativo": 1, "padrao": 0 } ] }, { "id": "1342", "nome": "Deduções", "tipo": "-", "nome_tipo": "Despesa", "ativo": 1, "padrao": 0, "subgrupos": [ { "id": "1343", "nome": "Impostos sobre vendas", "tipo": "-", "nome_tipo": "Despesa", "ativo": 1, "padrao": 0 }, { "id": "1344", "nome": "Comissões sobre vendas", "tipo": "-", "nome_tipo": "Despesa", "ativo": 1, "padrao": 0 }, { "id": "1345", "nome": "Devolução de vendas", "tipo": "-", "nome_tipo": "Despesa", "ativo": 1, "padrao": 0 } ] }, { "id": "1346", "nome": "Receita líquida", "tipo": "=", "nome_tipo": "Totalizador", "ativo": 1, "padrao": 0, "subgrupos": [] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/CategoriasMovimentacoesFinanceiras/index", "x-ia": "data.itens são os grupos de primeiro nível, na ordem do DRE; cada um traz subgrupos (também em ordem). tipo: + = receita, - = despesa, = = totalizador (linha de resultado, como Receita líquida — não recebe lançamento). ativo = 0 é grupo desligado. Os planos de contas ligados a cada subgrupo não vêm aqui; os valores do demonstrativo estão em /relatorios/dre. data.totais conta todos os grupos e subgrupos da busca, não só os da página.", "description": "Grupos e subgrupos do DRE da empresa (Financeiro > DRE > Grupos), na ordem em que aparecem no demonstrativo, com o tipo de cada um (receita, despesa ou totalizador).\n\nA tela de grupos do DRE usa a permissão do plano de contas. O cadastro é da empresa: não há filtro de loja.\n\n**Permissão exigida:** `Financeiro/CategoriasMovimentacoesFinanceiras/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/extratos_bancarios": { "get": { "tags": [ "Financeiro" ], "summary": "Listar extratos bancários para conciliação", "operationId": "financeiro_extratos_bancarios_listar", "x-modulo": "financeiro", "x-recurso": "extratos_bancarios", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data da importação)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — uma conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "ANDAMENTO = conciliação em andamento, CONCLUIDO = todas as linhas tratadas, ARQUIVADO = conciliação arquivada; sem ele entram andamento e concluído (arquivado só se pedido, como na tela)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "em_andamento": { "type": "integer" }, "concluidos": { "type": "integer" }, "arquivados": { "type": "integer" }, "lancamentos": { "type": "integer" }, "conciliados": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "conta_bancaria": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "origem": { "type": "string" }, "integrada": { "type": "boolean" }, "data_importacao": { "type": "string" }, "periodo_inicio": { "type": "string" }, "periodo_fim": { "type": "string" }, "total": { "type": "integer" }, "auto_conciliados": { "type": "integer" }, "situacao": { "type": "string" }, "situacao_nome": { "type": "string" }, "data_conclusao": { "type": [ "string", "null" ] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data da importação do extrato", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 1, "em_andamento": 1, "concluidos": 0, "arquivados": 0, "lancamentos": 3, "conciliados": 1 }, "itens": [ { "id": "1", "conta_bancaria_id": "1", "conta_bancaria": "Caixa", "loja_id": "65", "nome_loja": "Master", "origem": "ofx", "integrada": false, "data_importacao": "2026-10-27 09:00:00", "periodo_inicio": "2026-09-20", "periodo_fim": "2026-09-30", "total": 3, "auto_conciliados": 1, "situacao": "ANDAMENTO", "situacao_nome": "Em andamento", "data_conclusao": null } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/ContasBancarias/index", "x-periodo": { "data": "a data em que o extrato foi importado (não as datas das linhas do extrato)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Lista de extratos importados, não de lançamentos financeiros nem o relatório de extrato (/relatorios/extrato é o extrato do ERP, calculado dos lançamentos). O período é o da IMPORTAÇÃO: um extrato de setembro importado em outubro só aparece em outubro — periodo_inicio/periodo_fim dizem o que ele cobre. total = linhas do extrato e auto_conciliados = linhas já conciliadas (gravado pela conciliação). Só extratos de arquivo OFX; conta conectada por Open Finance é sincronizada e não aparece aqui. data.totais conta o período inteiro; data.itens é só uma página. Para ver linha a linha o que falta conciliar use /extratos_bancarios/{id}.", "description": "Extratos bancários (arquivo OFX) importados para a conciliação bancária: a conta, o período coberto, quantas linhas o extrato tem, quantas já foram conciliadas e a situação da conciliação; e o detalhe de um extrato com cada linha e a situação dela (conciliada, com sugestão, divergente ou arquivada). É a mesma regra da tela Contas bancárias > Conciliação. Só leitura: importar, conciliar, aprovar sugestão, arquivar e gerar o lançamento ficam na tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data em que o extrato foi importado (não as datas das linhas do extrato). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/ContasBancarias/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/extratos_bancarios/{id}": { "get": { "tags": [ "Financeiro" ], "summary": "Visualizar extratos bancários para conciliação", "operationId": "financeiro_extratos_bancarios_visualizar", "x-modulo": "financeiro", "x-recurso": "extratos_bancarios", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } }, { "name": "situacao", "in": "query", "required": false, "description": "pendentes = só as linhas ainda não tratadas (sugestão e divergente), CONCILIADO = só as conciliadas, ARQUIVADO = só as arquivadas; sem ele vêm todas", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página da lista em data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — linhas por página (padrão e máximo 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "saldo_atual_conta": { "type": "number" }, "saldo_pendente": { "type": "number" }, "recebimentos": { "type": "integer" }, "pagamentos": { "type": "integer" }, "conciliados": { "type": "integer" }, "sugestoes": { "type": "integer" }, "divergentes": { "type": "integer" }, "arquivados": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "type": "string" }, "descricao": { "type": "string" }, "tipo": { "type": "string" }, "valor": { "type": "integer" }, "saldo": { "type": [ "string", "null" ] }, "situacao": { "type": "string" }, "situacao_nome": { "type": "string" }, "movimentacao_financeira_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": [ "string", "null" ] }, "nome_plano": { "type": [ "string", "null" ] }, "importado_anteriormente": { "type": "boolean" }, "lancamento": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "pessoa": { "type": "string" }, "data_vencimento": { "type": "string" } } } } } }, "extrato": { "type": "object", "properties": { "id": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "conta_bancaria": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "origem": { "type": "string" }, "integrada": { "type": "boolean" }, "data_importacao": { "type": "string" }, "periodo_inicio": { "type": "string" }, "periodo_fim": { "type": "string" }, "total": { "type": "integer" }, "auto_conciliados": { "type": "integer" }, "situacao": { "type": "string" }, "situacao_nome": { "type": "string" }, "data_conclusao": { "type": [ "string", "null" ] }, "extratos_no_escopo": { "type": "integer" } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 3, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "saldo_atual_conta": 350.5, "saldo_pendente": 148.400000000000005684341886080801486968994140625, "recebimentos": 2, "pagamentos": 1, "conciliados": 1, "sugestoes": 0, "divergentes": 2, "arquivados": 0 }, "itens": [ { "id": "1", "data": "2026-09-24", "descricao": "TESTE GCK-22595 venda balcao", "tipo": "C", "valor": 215, "saldo": null, "situacao": "CONCILIADO", "situacao_nome": "Conciliado", "movimentacao_financeira_id": "133623354", "nome_forma_pagamento": "Dinheiro à Vista", "plano_contas_id": null, "nome_plano": null, "importado_anteriormente": false, "lancamento": { "id": "133623354", "codigo": "3119", "tipo": "C", "pessoa": "Cliente TESTE SR", "data_vencimento": "2026-09-24" } }, { "id": "2", "data": "2026-09-25", "descricao": "TESTE GCK-22595 tarifa bancaria", "tipo": "D", "valor": 12.9000000000000003552713678800500929355621337890625, "saldo": null, "situacao": "DIVERGENTE", "situacao_nome": "Divergente", "movimentacao_financeira_id": null, "nome_forma_pagamento": null, "plano_contas_id": null, "nome_plano": null, "importado_anteriormente": false, "lancamento": null }, { "id": "3", "data": "2026-09-26", "descricao": "TESTE GCK-22595 pix recebido", "tipo": "C", "valor": 135.5, "saldo": null, "situacao": "DIVERGENTE", "situacao_nome": "Divergente", "movimentacao_financeira_id": null, "nome_forma_pagamento": null, "plano_contas_id": null, "nome_plano": null, "importado_anteriormente": false, "lancamento": null } ], "extrato": { "id": "1", "conta_bancaria_id": "1", "conta_bancaria": "Caixa", "loja_id": "65", "nome_loja": "Master", "origem": "ofx", "integrada": false, "data_importacao": "2026-10-27 09:00:00", "periodo_inicio": "2026-09-20", "periodo_fim": "2026-09-30", "total": 3, "auto_conciliados": 1, "situacao": "ANDAMENTO", "situacao_nome": "Em andamento", "data_conclusao": null, "extratos_no_escopo": 1 } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/ContasBancarias/index", "x-ia": "Detalhe de um extrato das lojas do usuário da chave (404 se for de outra loja ou não existir). data.extrato é o cabeçalho; data.itens são as linhas do extrato (uma página). situacao de cada linha: CONCILIADO = já vinculada a um lançamento do financeiro (lancamento traz qual); SUGESTAO = a conciliação automática achou um lançamento compatível (lancamento traz o sugerido), mas o usuário ainda não aprovou — NÃO está conciliada; DIVERGENTE = sem lançamento compatível (falta lançar ou o valor/data não bate); ARQUIVADO = descartada pelo usuário sem conciliar. A análise é feita na hora, como a tela abre: a sugestão pode mudar se o financeiro mudar. data.totais: conciliados/sugestoes/divergentes/arquivados contam as linhas do recorte de situacao; saldo_pendente é a soma (sem sinal) das linhas ainda não tratadas e recebimentos/pagamentos contam as linhas de crédito/débito do extrato inteiro; saldo_atual_conta é o saldo da conta no ERP hoje (lançamentos baixados), não o saldo do banco. valor das linhas vem sem sinal: tipo C = entrada, D = saída.", "description": "**Permissão exigida:** `Financeiro/ContasBancarias/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/pagamentos/totais": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar totais de pagamentos", "operationId": "financeiro_pagamentos_totais_listar", "x-modulo": "financeiro", "x-recurso": "pagamentos_totais", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa (a listagem /pagamentos usa só a loja padrão da chave)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — código do lançamento; com ele o período não se aplica", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — trecho da descrição", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora (ids em /transportadoras)", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — um funcionário (ids em /funcionarios)", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "float — valor total mínimo", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "float — valor total máximo", "schema": { "type": "string" } }, { "name": "liquidado", "in": "query", "required": false, "description": "ab = em aberto, at = em atraso (em aberto com data de fluxo antes de hoje), pg = confirmado (baixado); sem ele entram todos. Outro valor é 400", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação do lançamento", "schema": { "type": "string" } }, { "name": "plano_contas_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "total": { "type": "integer" }, "em_aberto": { "type": "integer" }, "vencidos": { "type": "integer" }, "vencem_hoje": { "type": "integer" }, "a_vencer": { "type": "integer" }, "pagos": { "type": "integer" } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-01-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "cache": false }, "data": { "totais": { "total": 720, "em_aberto": 0, "vencidos": 0, "vencem_hoje": 0, "a_vencer": 0, "pagos": 720 } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_pagamento", "x-periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Use para \"quanto tenho a pagar\" num período. Os valores já vêm somados em data.totais (número, reais) — não some a listagem. total = tudo do período; pagos = já baixados (confirmados); em_aberto = total − pagos (tudo o que não foi baixado). vencidos, vencem_hoje e a_vencer olham a data de VENCIMENTO contra hoje, só dos não baixados: vencidos exclui as situações configuradas para não aparecer como atrasadas, então vencidos + vencem_hoje + a_vencer pode ser menor que em_aberto. O período filtra a data de fluxo (meta.periodo; sem datas = mês atual) — cite-o na resposta. Ocorrências previstas de contas fixas (ainda não geradas) não entram, ao contrário do card da tela, que as soma no front. Sem loja_id soma todas as lojas do usuário da chave (meta.loja_id). Sem a permissão Financeiro/MovimentacoesFinanceiras/liberado_usuario, só os lançamentos do próprio usuário. Para a lista de lançamentos use GET /pagamentos; para totais com descontos, juros e taxas use /relatorios/contas_pagar.", "description": "Totais das contas a pagar no período: total, em aberto, vencidos, que vencem hoje, a vencer e pagos. É o card de totais da listagem de contas a pagar e aceita os filtros de GET /pagamentos, menos venda, compra e o período por competência (data_inicio_emissao/data_fim_emissao), que aqui são ignorados.\n\nExige também a permissão `Financeiro/MovimentacoesFinanceiras/fluxo_caixa`, como o card da tela: sem uma das duas, 403.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram data de fluxo (vencimento; data da baixa quando baixado). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_pagamento` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/contas_bancarias/painel": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar painel de contas bancárias", "operationId": "financeiro_painel_contas_bancarias_listar", "x-modulo": "financeiro", "x-recurso": "painel_contas_bancarias", "x-operacao": "listar", "parameters": [ { "name": "data_corte", "in": "query", "required": false, "description": "AAAA-MM-DD — saldo até este dia; padrão hoje", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram as contas de todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página da lista em data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — contas por página (padrão e máximo 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "data_corte": { "type": "string" }, "quantidade_contas": { "type": "integer" }, "saldo_total": { "type": "number" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "banco": { "type": [ "string", "null" ] }, "nome_banco": { "type": [ "string", "null" ] }, "saldo": { "type": "integer" }, "movimentada_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 40, "pagina": 1, "limite": 3, "total_paginas": 14, "cache": false }, "data": { "totais": { "data_corte": "2026-10-27", "quantidade_contas": 40, "saldo_total": -369.5 }, "itens": [ { "id": "179", "nome": "add", "banco": null, "nome_banco": null, "saldo": -720, "movimentada_em": "2026-10-27 16:14:19" }, { "id": "655", "nome": "Ads SICRED", "banco": null, "nome_banco": null, "saldo": 0, "movimentada_em": null }, { "id": "118", "nome": "Banco Bradesco", "banco": null, "nome_banco": null, "saldo": 0, "movimentada_em": "2024-11-29 18:23:02" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/ContasBancarias/visualizar_saldo", "x-ia": "Saldo REALIZADO de cada conta: soma só os lançamentos baixados (pagos/recebidos) até data.totais.data_corte — cite a data. É o número do painel inicial e da coluna Saldo da listagem de contas. Difere de /relatorios/contas_bancarias sem baixado=pg, que projeta o que está em aberto. data.totais.saldo_total soma todas as contas (inclusive as que não estão na página); data.itens vem em ordem de nome e é só uma página. Saldo negativo existe: responda com o sinal. Não traz agência, número da conta nem dados da integração bancária.", "description": "Saldo de cada conta bancária numa data (lançamentos baixados até ela), com o banco e a última movimentação, e o saldo somado. É a mesma regra do card Contas bancárias do painel inicial.\n\nExige também a permissão `Financeiro/ContasBancarias/index` (listar contas), como o card do painel: sem uma das duas, 403.\n\n**Permissão exigida:** `Financeiro/ContasBancarias/visualizar_saldo` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/recebimentos/totais": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar totais de recebimentos", "operationId": "financeiro_recebimentos_totais_listar", "x-modulo": "financeiro", "x-recurso": "recebimentos_totais", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa (a listagem /recebimentos usa só a loja padrão da chave)", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — código do lançamento; com ele o período não se aplica", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — trecho da descrição", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora (ids em /transportadoras)", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — um funcionário (ids em /funcionarios)", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "float — valor total mínimo", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "float — valor total máximo", "schema": { "type": "string" } }, { "name": "liquidado", "in": "query", "required": false, "description": "ab = em aberto, at = em atraso (em aberto com data de fluxo antes de hoje), pg = confirmado (baixado); sem ele entram todos. Outro valor é 400", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação do lançamento", "schema": { "type": "string" } }, { "name": "plano_contas_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "total": { "type": "number" }, "em_aberto": { "type": "integer" }, "vencidos": { "type": "integer" }, "vencem_hoje": { "type": "integer" }, "a_vencer": { "type": "integer" }, "recebidos": { "type": "number" } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "cache": false }, "data": { "totais": { "total": 470.5, "em_aberto": 350, "vencidos": 350, "vencem_hoje": 0, "a_vencer": 0, "recebidos": 120.5 } } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_recebimento", "x-periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Use para \"quanto tenho a receber\" num período. Os valores já vêm somados em data.totais (número, reais) — não some a listagem. total = tudo do período; recebidos = já baixados (confirmados); em_aberto = total − recebidos (tudo o que não foi baixado). vencidos, vencem_hoje e a_vencer olham a data de VENCIMENTO contra hoje, só dos não baixados: vencidos exclui as situações configuradas para não aparecer como atrasadas, então vencidos + vencem_hoje + a_vencer pode ser menor que em_aberto. O período filtra a data de fluxo (meta.periodo; sem datas = mês atual) — cite-o na resposta. Ocorrências previstas de contas fixas (ainda não geradas) não entram, ao contrário do card da tela, que as soma no front. Sem loja_id soma todas as lojas do usuário da chave (meta.loja_id). Sem a permissão Financeiro/MovimentacoesFinanceiras/liberado_usuario, só os lançamentos do próprio usuário. Para a lista de lançamentos use GET /recebimentos; para totais com descontos, juros e taxas use /relatorios/contas_receber.", "description": "Totais das contas a receber no período: total, em aberto, vencidos, que vencem hoje, a vencer e recebidos. É o card de totais da listagem de contas a receber e aceita os filtros de GET /recebimentos, menos venda, contrato e o período por competência (data_inicio_emissao/data_fim_emissao), que aqui são ignorados.\n\nExige também a permissão `Financeiro/MovimentacoesFinanceiras/fluxo_caixa`, como o card da tela: sem uma das duas, 403.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram data de fluxo (vencimento; data da baixa quando baixado). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_recebimento` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/centros_custos": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar relatório por centro de custo", "operationId": "financeiro_relatorio_centros_custos_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_centros_custos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação personalizada da movimentação (situacao_id e situacao_nome vêm nas linhas deste relatório; /recebimentos e /pagamentos não trazem a situação)", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); categoria pai inclui as filhas; com rateio, só a parte rateada", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = baixado (pago/recebido); sem ele entram todos", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "entradas": { "type": "integer" }, "saidas": { "type": "integer" }, "saldo": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "quantidade": 0, "entradas": 0, "saidas": 0, "saldo": 0 }, "itens": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/fluxo_caixa", "x-periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda os quatro números juntos (quantidade, entradas, saídas, saldo) com o período e as lojas. Só entram lançamentos com centro de custo preenchido ou rateado: zerado pode ser falta de cadastro de centro de custo, não ausência de gasto. A quebra por centro não vem pronta: para um centro, filtre com centro_custo_id em vez de somar data.itens (que é só uma página).", "description": "Lançamentos com centro de custo (próprio ou por rateio) do período, com quantidade, entradas, saídas e saldo já somados, e a lista dos lançamentos. É a mesma regra do relatório de centros de custo da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; data da baixa quando baixado). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/fluxo_caixa` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/comissao_vendedores_financeiro": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar comissão de vendedores (sobre o financeiro)", "operationId": "financeiro_relatorio_comissao_vendedores_financeiro_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_comissao_vendedores_financeiro", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo das parcelas)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — um vendedor (ids em /funcionarios)", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); categoria pai inclui as filhas; com rateio, só a parte rateada", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo da venda ou da movimentação", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = baixado (pago/recebido); sem ele entram todos", "schema": { "type": "string" } }, { "name": "comissao_regra", "in": "query", "required": false, "description": "F = integral ao gerar o financeiro, P = integral na 1ª parcela, U = integral na última parcela, R = parcial conforme o recebimento", "schema": { "type": "string" } }, { "name": "comissao_situacao", "in": "query", "required": false, "description": "pendente, parcial, liberada ou cancelado — situação da liberação da comissão", "schema": { "type": "string" } }, { "name": "considerar_devolucoes", "in": "query", "required": false, "description": "1 = abate as devoluções do cálculo", "schema": { "type": "string" } }, { "name": "exibir_comissao_bruta", "in": "query", "required": false, "description": "1 = calcula sobre o valor nominal da parcela em vez do valor total (com juros/descontos)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "quantidade_vendedores": { "type": "integer" }, "total_bruto": { "type": "integer" }, "total_comissao": { "type": "number" }, "ticket_medio": { "type": "number" }, "maior_comissao_vendedor": { "type": "string" }, "comissao_devida": { "type": "number" }, "comissao_liberada": { "type": "number" }, "comissao_pendente": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "codigo": { "type": "string" }, "identificacao_parcela": { "type": "string" }, "compra_id": { "type": "string" }, "pedido_id": { "type": "string" }, "pedido_parcela_id": { "type": "string" }, "contrato_id": { "type": "string" }, "nome_categoria": { "type": "string" }, "data_fluxo": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_baixa": { "type": "string" }, "juros": { "type": "integer" }, "desconto": { "type": "integer" }, "taxa_banco": { "type": "integer" }, "taxa_operadora": { "type": "integer" }, "valor": { "type": "integer" }, "valor_total": { "type": "integer" }, "baixado": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_loja": { "type": "string" }, "nome_cliente": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "nome_transportadora": { "type": "string" }, "nome_funcionario": { "type": "string" }, "outros": { "type": "string" }, "possui_rateio": { "type": "boolean" }, "situacao_nome": { "type": "string" }, "situacao_cor": { "type": [ "string", "null" ] }, "situacao_classe": { "type": "string" }, "classeTipo": { "type": "string" }, "categorias_agrupadas": { "type": "integer" }, "centros_custos_agrupados": { "type": "integer" }, "destinado": { "type": "string" }, "valor_bruto_formatado": { "type": "integer" }, "comissao_bruta_formatada": { "type": "number" }, "data_fluxo_formatada": { "type": "string" }, "vendedor_id": { "type": "integer" }, "nome_vendedor": { "type": "string" }, "comissao_regra": { "type": "string" }, "comissao_situacao": { "type": "string" }, "comissao_situacao_chave": { "type": "string" }, "comissao_devida_venda": { "type": "number" }, "comissao_liberada_venda": { "type": "number" }, "comissao_pendente": { "type": "integer" }, "comissao_legado": { "type": "boolean" } } } }, "vendedores": { "type": "array", "items": { "type": "object", "properties": { "vendedor_id": { "type": "string" }, "linhas": { "type": "array", "items": { "type": "object", "properties": { "pedido_id": { "type": "string" }, "codigo": { "type": "string" }, "nome_cliente": { "type": "string" }, "comissao_devida": { "type": "number" }, "comissao_liberada": { "type": "number" }, "comissao_pendente": { "type": "integer" }, "regra": { "type": "string" }, "regra_chave": { "type": "string" }, "comissao_porcentagem": { "type": "integer" }, "situacao": { "type": "string" }, "situacao_chave": { "type": "string" }, "legado": { "type": "boolean" } } } }, "totais": { "type": "object", "properties": { "devido": { "type": "integer" }, "liberado": { "type": "integer" }, "pendente": { "type": "integer" } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo das movimentações (vencimento; data da baixa quando baixado)", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 13, "pagina": 1, "limite": 2, "total_paginas": 7, "cache": true }, "data": { "totais": { "quantidade": 13, "quantidade_vendedores": 2, "total_bruto": 3530, "total_comissao": 33022.669999999998253770172595977783203125, "ticket_medio": 271.54000000000002046363078989088535308837890625, "maior_comissao_vendedor": "JOÃO DO BD COMPARTILHADO!", "comissao_devida": 33022.669999999998253770172595977783203125, "comissao_liberada": 33022.669999999998253770172595977783203125, "comissao_pendente": 0 }, "itens": [ { "id": "133623354", "nome": "Venda de nº 9", "codigo": "3119", "identificacao_parcela": "", "compra_id": "", "pedido_id": "7060", "pedido_parcela_id": "8204", "contrato_id": "", "nome_categoria": "", "data_fluxo": "2026-09-24", "data_vencimento": "2026-09-24", "data_baixa": "2026-09-24", "juros": 0, "desconto": 0, "taxa_banco": 0, "taxa_operadora": 0, "valor": 215, "valor_total": 215, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "nome_cliente": "Cliente TESTE SR", "nome_fornecedor": "", "nome_transportadora": "", "nome_funcionario": "", "outros": "", "possui_rateio": false, "situacao_nome": "Confirmado", "situacao_cor": null, "situacao_classe": "success", "classeTipo": "", "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "destinado": "Cliente TESTE SR", "valor_bruto_formatado": 215, "comissao_bruta_formatada": 21.5, "data_fluxo_formatada": "2026-09-24", "vendedor_id": 130854, "nome_vendedor": "Usuário", "comissao_regra": "Integral ao gerar financeiro", "comissao_situacao": "Totalmente liberada", "comissao_situacao_chave": "liberada", "comissao_devida_venda": 21.5, "comissao_liberada_venda": 21.5, "comissao_pendente": 0, "comissao_legado": false }, { "id": "133623355", "nome": "Venda de nº 10", "codigo": "3120", "identificacao_parcela": "", "compra_id": "", "pedido_id": "7061", "pedido_parcela_id": "8205", "contrato_id": "", "nome_categoria": "", "data_fluxo": "2026-09-25", "data_vencimento": "2026-09-25", "data_baixa": "2026-09-25", "juros": 0, "desconto": 0, "taxa_banco": 0, "taxa_operadora": 0, "valor": 15, "valor_total": 15, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "nome_cliente": "", "nome_fornecedor": "", "nome_transportadora": "", "nome_funcionario": "", "outros": "", "possui_rateio": false, "situacao_nome": "Confirmado", "situacao_cor": null, "situacao_classe": "success", "classeTipo": "", "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "destinado": "", "valor_bruto_formatado": 15, "comissao_bruta_formatada": 1.5, "data_fluxo_formatada": "2026-09-25", "vendedor_id": 130854, "nome_vendedor": "Usuário", "comissao_regra": "Integral ao gerar financeiro", "comissao_situacao": "Totalmente liberada", "comissao_situacao_chave": "liberada", "comissao_devida_venda": 1.5, "comissao_liberada_venda": 1.5, "comissao_pendente": 0, "comissao_legado": false } ], "vendedores": [ { "vendedor_id": "130854", "linhas": [ { "pedido_id": "7060", "codigo": "3119", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 21.5, "comissao_liberada": 21.5, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 10, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7061", "codigo": "3120", "nome_cliente": "", "comissao_devida": 1.5, "comissao_liberada": 1.5, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 10, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false } ], "totais": { "devido": 23, "liberado": 23, "pendente": 0 } }, { "vendedor_id": "45", "linhas": [ { "pedido_id": "7065", "codigo": "3209", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7070", "codigo": "3210", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7075", "codigo": "3211", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7080", "codigo": "3212", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7085", "codigo": "3213", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7090", "codigo": "3214", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7095", "codigo": "3215", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7100", "codigo": "3216", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7105", "codigo": "3217", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7110", "codigo": "3218", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false }, { "pedido_id": "7115", "codigo": "3219", "nome_cliente": "Cliente TESTE SR", "comissao_devida": 2999.96999999999979991116560995578765869140625, "comissao_liberada": 2999.96999999999979991116560995578765869140625, "comissao_pendente": 0, "regra": "Integral ao gerar financeiro", "regra_chave": "F", "comissao_porcentagem": 999.990000000000009094947017729282379150390625, "situacao": "Totalmente liberada", "situacao_chave": "liberada", "legado": false } ], "totais": { "devido": 32999.669999999998253770172595977783203125, "liberado": 32999.669999999998253770172595977783203125, "pendente": 0 } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/comissao_vendedores", "x-periodo": { "data": "a data de fluxo das parcelas (vencimento; data da baixa quando baixado)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Diga sempre que a base é o financeiro (parcelas pela data de fluxo), não a venda emitida. Os totais já vêm somados em data.totais: total_comissao, total_bruto, quantidade (parcelas) e quantidade_vendedores; comissao_liberada/comissao_pendente respondem \"o que já posso pagar\". Venda cancelada aparece em data.itens mas não entra em nenhum total. data.vendedores traz o bloco de cada vendedor (totais devido/liberado/pendente). data.itens é só uma página — nunca some as linhas.", "description": "Comissão dos vendedores calculada sobre as movimentações financeiras do período (data de fluxo das parcelas de vendas, contratos e locações), com total bruto, total de comissão, ticket médio, devido, liberado e pendente já somados, a lista das parcelas e o bloco por vendedor. É a mesma regra do relatório de comissão de vendedores do Financeiro; a comissão sobre a venda emitida é outro relatório.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo das parcelas (vencimento; data da baixa quando baixado). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/comissao_vendedores` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/contas_bancarias": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar saldo das contas bancárias", "operationId": "financeiro_relatorio_contas_bancarias_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_contas_bancarias", "x-operacao": "listar", "parameters": [ { "name": "data_corte", "in": "query", "required": false, "description": "AAAA-MM-DD — saldo acumulado até este dia (\"até o dia\" da tela); padrão hoje. Não existe data inicial", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — uma conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "pg = só lançamentos baixados (saldo realizado), ab = só em aberto, at = só atrasados; sem ele soma baixados e em aberto (saldo projetado)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "data_corte": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "data_corte": { "type": "string" }, "quantidade_contas": { "type": "integer" }, "saldo_total": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "saldo": { "type": "integer" }, "lojas": { "type": "object", "properties": [] } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "data_corte": "2026-09-30" }, "total_registros": 40, "pagina": 1, "limite": 2, "total_paginas": 20, "cache": true }, "data": { "totais": { "data_corte": "2026-09-30", "quantidade_contas": 40, "saldo_total": 3530 }, "itens": [ { "id": "179", "nome": "add", "saldo": 0, "lojas": [] }, { "id": "655", "nome": "Ads SICRED", "saldo": 0, "lojas": [] } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/ContasBancarias/visualizar_saldo", "x-ia": "Não tem período: é o saldo acumulado até data.totais.data_corte — cite a data. Sem baixado=pg o saldo é PROJETADO (inclui o que está em aberto até a data de corte) e pode divergir do saldo do painel de contas bancárias, que só conta baixados: diga qual usou. data.totais.saldo_total soma as contas listadas; data.itens traz o saldo de cada conta e lojas[] só com as lojas que têm lançamento. Responda por conta, com o sinal (saldo negativo existe).", "description": "Saldo acumulado de cada conta bancária até uma data de corte (entradas menos saídas de todo o histórico), com o saldo por loja e o total. É a mesma regra do relatório de contas bancárias da tela.\n\n**Permissão exigida:** `Financeiro/ContasBancarias/visualizar_saldo` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/contas_pagar": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar relatório de contas a pagar", "operationId": "financeiro_relatorio_contas_pagar_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_contas_pagar", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo, ou de emissão com tipo_data=emissao)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo_data", "in": "query", "required": false, "description": "fluxo (padrão) ou emissao — qual data o período recorta", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação personalizada da movimentação (situacao_id e situacao_nome vêm nas linhas deste relatório; /recebimentos e /pagamentos não trazem a situação)", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); categoria pai inclui as filhas; com rateio, só a parte rateada", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = baixado (pago/recebido); sem ele entram todos", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "total": { "type": "integer" }, "a_pagar": { "type": "integer" }, "pago": { "type": "integer" }, "atrasado": { "type": "integer" }, "hoje": { "type": "integer" }, "futuro": { "type": "integer" }, "descontos": { "type": "integer" }, "juros": { "type": "integer" }, "taxa_banco": { "type": "integer" }, "taxa_operadora": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "quantidade": 0, "total": 0, "a_pagar": 0, "pago": 0, "atrasado": 0, "hoje": 0, "futuro": 0, "descontos": 0, "juros": 0, "taxa_banco": 0, "taxa_operadora": 0 }, "itens": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_pagamento", "x-periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado); com tipo_data=emissao, a data de emissão", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: responda quantidade e valor juntos e cite o período de meta.periodo e as lojas de meta.loja_id. quantidade conta parcelas (uma compra em 10x conta 10), não fornecedores. total = pago + a_pagar; atrasado, hoje e futuro são partes de a_pagar (não some com ele) e são calculados contra a data de hoje — em período passado, o que ficou em aberto aparece como atrasado. data.itens é só uma página — nunca some as linhas. Zerado é resposta válida (nenhuma conta a pagar no período). Nunca junte com contas a receber.", "description": "Contas a pagar do período já somadas — quantidade, total, em aberto, pago, atrasado, vence hoje, futuro, descontos, juros e taxas — e a lista das parcelas. É a mesma regra do relatório de contas a pagar da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; data da baixa quando baixado); com tipo_data=emissao, a data de emissão. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_pagamento` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/contas_receber": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar relatório de contas a receber", "operationId": "financeiro_relatorio_contas_receber_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_contas_receber", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo, ou de emissão com tipo_data=emissao)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo_data", "in": "query", "required": false, "description": "fluxo (padrão) ou emissao — qual data o período recorta", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação personalizada da movimentação (situacao_id e situacao_nome vêm nas linhas deste relatório; /recebimentos e /pagamentos não trazem a situação)", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); categoria pai inclui as filhas; com rateio, só a parte rateada", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = baixado (pago/recebido); sem ele entram todos", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "total": { "type": "integer" }, "a_receber": { "type": "integer" }, "recebido": { "type": "integer" }, "atrasado": { "type": "integer" }, "hoje": { "type": "integer" }, "futuro": { "type": "integer" }, "descontos": { "type": "integer" }, "juros": { "type": "integer" }, "taxa_banco": { "type": "integer" }, "taxa_operadora": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "codigo": { "type": "string" }, "identificacao_parcela": { "type": [ "string", "null" ] }, "compra_id": { "type": [ "string", "null" ] }, "pedido_id": { "type": "string" }, "contrato_id": { "type": [ "string", "null" ] }, "nome_categoria": { "type": [ "string", "null" ] }, "nome_centro_custo": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "data_fluxo": { "type": "string" }, "data_emissao": { "type": "string" }, "data_vencimento": { "type": "string" }, "data_baixa": { "type": "string" }, "juros": { "type": "integer" }, "desconto": { "type": "integer" }, "taxa_banco": { "type": "integer" }, "taxa_operadora": { "type": "integer" }, "taxa_fixa_cartao": { "type": "integer" }, "valor": { "type": "integer" }, "valor_total": { "type": "integer" }, "baixado": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_loja": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "nome_fornecedor": { "type": [ "string", "null" ] }, "transportadora_id": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "outros": { "type": [ "string", "null" ] }, "nota_fiscal_id": { "type": [ "string", "null" ] }, "nota_fiscal_servico_id": { "type": [ "string", "null" ] }, "possui_rateio": { "type": "boolean" }, "situacao_nome": { "type": "string" }, "situacao_cor": { "type": "string" }, "situacao_classe": { "type": "string" }, "classeTipo": { "type": "string" }, "categorias_agrupadas": { "type": "integer" }, "centros_custos_agrupados": { "type": "integer" }, "pf_cpf": { "type": "string" }, "pj_cnpj": { "type": "string" }, "fornecedor_pj_cnpj": { "type": "string" }, "fornecedor_pf_cpf": { "type": "string" }, "transportadora_pj_cnpj": { "type": "string" }, "transportadora_pf_cpf": { "type": "string" }, "funcionario_pj_cnpj": { "type": "string" }, "funcionario_pf_cpf": { "type": "string" }, "cliente_pj_cnpj": { "type": "string" }, "cliente_pf_cpf": { "type": "string" }, "nome_principal": { "type": "string" }, "cpfCnpjPrincipal": { "type": "string" }, "descComParcela": { "type": "string" }, "nomeCategoriaOuRateio": { "type": "string" }, "nomeCentroCustoOuRateio": { "type": "string" }, "dataEmissaoFormatada": { "type": "string" }, "dataVencimentoFormatada": { "type": "string" }, "dataBaixaFormatada": { "type": "string" }, "numeroNotaFiscal": { "type": "string" }, "numeroNotaFiscalServico": { "type": "string" }, "atributos_conteudos": { "type": "object", "properties": [] }, "valorTotalFormatado": { "type": "integer" }, "descontoFormatado": { "type": "integer" }, "jurosFormatado": { "type": "integer" }, "taxaBancoFormatado": { "type": "integer" }, "taxaOperadoraFormatado": { "type": "integer" }, "valorTotalGeralFormatado": { "type": "integer" }, "rateio_centros_custos": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "descricao_quantidade": { "type": "string" }, "nomes": { "type": "string" }, "nomes_array": { "type": "object", "properties": [] } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 13, "pagina": 1, "limite": 2, "total_paginas": 7, "cache": true }, "data": { "totais": { "quantidade": 13, "total": 3530, "a_receber": 3300, "recebido": 230, "atrasado": 3300, "hoje": 0, "futuro": 0, "descontos": 0, "juros": 0, "taxa_banco": 0, "taxa_operadora": 0 }, "itens": [ { "id": "133623354", "nome": "Venda de nº 9", "codigo": "3119", "identificacao_parcela": null, "compra_id": null, "pedido_id": "7060", "contrato_id": null, "nome_categoria": null, "nome_centro_custo": "", "nome_forma_pagamento": "Dinheiro à Vista", "nome_conta_bancaria": "Caixa", "data_fluxo": "2026-09-24", "data_emissao": "2026-09-24", "data_vencimento": "2026-09-24", "data_baixa": "2026-09-24", "juros": 0, "desconto": 0, "taxa_banco": 0, "taxa_operadora": 0, "taxa_fixa_cartao": 0, "valor": 215, "valor_total": 215, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "fornecedor_id": null, "nome_fornecedor": null, "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "outros": null, "nota_fiscal_id": null, "nota_fiscal_servico_id": null, "possui_rateio": false, "situacao_nome": "Confirmado", "situacao_cor": "", "situacao_classe": "success", "classeTipo": "", "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "pf_cpf": "", "pj_cnpj": "", "fornecedor_pj_cnpj": "", "fornecedor_pf_cpf": "", "transportadora_pj_cnpj": "", "transportadora_pf_cpf": "", "funcionario_pj_cnpj": "", "funcionario_pf_cpf": "", "cliente_pj_cnpj": "", "cliente_pf_cpf": "", "nome_principal": "Cliente TESTE SR", "cpfCnpjPrincipal": "", "descComParcela": "Venda de nº 9", "nomeCategoriaOuRateio": "", "nomeCentroCustoOuRateio": "", "dataEmissaoFormatada": "2026-09-24", "dataVencimentoFormatada": "2026-09-24", "dataBaixaFormatada": "2026-09-24", "numeroNotaFiscal": "", "numeroNotaFiscalServico": "", "atributos_conteudos": [], "valorTotalFormatado": 215, "descontoFormatado": 0, "jurosFormatado": 0, "taxaBancoFormatado": 0, "taxaOperadoraFormatado": 0, "valorTotalGeralFormatado": 215, "rateio_centros_custos": { "quantidade": 0, "descricao_quantidade": "0 centro de custos", "nomes": "", "nomes_array": [] } }, { "id": "133623355", "nome": "Venda de nº 10", "codigo": "3120", "identificacao_parcela": null, "compra_id": null, "pedido_id": "7061", "contrato_id": null, "nome_categoria": null, "nome_centro_custo": "", "nome_forma_pagamento": "Dinheiro à Vista", "nome_conta_bancaria": "Caixa", "data_fluxo": "2026-09-25", "data_emissao": "2026-09-25", "data_vencimento": "2026-09-25", "data_baixa": "2026-09-25", "juros": 0, "desconto": 0, "taxa_banco": 0, "taxa_operadora": 0, "taxa_fixa_cartao": 0, "valor": 15, "valor_total": 15, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "cliente_id": null, "nome_cliente": null, "fornecedor_id": null, "nome_fornecedor": null, "transportadora_id": null, "nome_transportadora": null, "funcionario_id": null, "nome_funcionario": null, "outros": null, "nota_fiscal_id": null, "nota_fiscal_servico_id": null, "possui_rateio": false, "situacao_nome": "Confirmado", "situacao_cor": "", "situacao_classe": "success", "classeTipo": "", "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "pf_cpf": "", "pj_cnpj": "", "fornecedor_pj_cnpj": "", "fornecedor_pf_cpf": "", "transportadora_pj_cnpj": "", "transportadora_pf_cpf": "", "funcionario_pj_cnpj": "", "funcionario_pf_cpf": "", "cliente_pj_cnpj": "", "cliente_pf_cpf": "", "nome_principal": "", "cpfCnpjPrincipal": "", "descComParcela": "Venda de nº 10", "nomeCategoriaOuRateio": "", "nomeCentroCustoOuRateio": "", "dataEmissaoFormatada": "2026-09-25", "dataVencimentoFormatada": "2026-09-25", "dataBaixaFormatada": "2026-09-25", "numeroNotaFiscal": "", "numeroNotaFiscalServico": "", "atributos_conteudos": [], "valorTotalFormatado": 15, "descontoFormatado": 0, "jurosFormatado": 0, "taxaBancoFormatado": 0, "taxaOperadoraFormatado": 0, "valorTotalGeralFormatado": 15, "rateio_centros_custos": { "quantidade": 0, "descricao_quantidade": "0 centro de custos", "nomes": "", "nomes_array": [] } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_recebimento", "x-periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado); com tipo_data=emissao, a data de emissão", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais: responda quantidade e valor juntos e cite o período de meta.periodo e as lojas de meta.loja_id. total = recebido + a_receber, e a_receber = atrasado + hoje + futuro: nunca apresente total como \"quanto tenho a receber\" (inclui o que já entrou). atrasado/hoje/futuro são calculados contra a data de hoje. Conta a receber em aberto é previsão, não dinheiro em caixa. quantidade conta lançamentos (parcelas), não clientes. data.itens é só uma página — nunca some as linhas. Por fluxo e por emissão (tipo_data) dão números diferentes no mesmo intervalo: diga qual usou.", "description": "Contas a receber do período já somadas — quantidade, total, em aberto, recebido, atrasado, vence hoje, futuro, descontos, juros e taxas — e a lista das parcelas. É a mesma regra do relatório de contas a receber da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; data da baixa quando baixado); com tipo_data=emissao, a data de emissão. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_recebimento` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/dre": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar DRE gerencial", "operationId": "financeiro_relatorio_dre_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_dre", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — o mês desta data é o primeiro do DRE (o dia é ignorado)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — o mês desta data é o último do DRE (o dia é ignorado)", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo_data", "in": "query", "required": false, "description": "DM = data de movimentação/fluxo (padrão), DC = data de competência (emissão)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = só em aberto, at = só atrasados, pg = só baixados; sem ele entram baixados e em aberto", "schema": { "type": "string" } }, { "name": "categoria_dre_id", "in": "query", "required": false, "description": "int — uma linha (categoria) do DRE da empresa (ids em data.itens[].id)", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "exibir_transferencia", "in": "query", "required": false, "description": "0 = tira as transferências entre contas; padrão 1", "schema": { "type": "string" } }, { "name": "previstas", "in": "query", "required": false, "description": "1 = inclui as contas fixas previstas (ocorrências futuras de contas fixas ainda não lançadas, contas fixas versão 2), o alternador \"Previstas\" da tela; padrão 0. Só vale para a empresa com contas fixas v2 — veja data.totais.previstas.disponiveis", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "resultado": { "type": "integer" }, "resultado_linha": { "type": "string" }, "linhas": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "valor": { "type": "integer" } } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "padrao": { "type": "string" }, "categoria_id": { "type": "string" }, "nivel": { "type": "integer" }, "categorias": { "type": "object", "properties": [] }, "movimentacoes": { "type": "object", "properties": { "2026-09": { "type": "integer" }, "total": { "type": "integer" } } } } } }, "periodos": { "type": "array", "items": { "type": "object", "properties": { "chave": { "type": "string" }, "valor": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "mês da data de movimentação (ou de competência com tipo_data=DC), meses inteiros de data_inicio a data_fim", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 26, "pagina": 1, "limite": 2, "total_paginas": 13, "cache": true }, "data": { "totais": { "resultado": 0, "resultado_linha": "Lucro/prejuízo", "linhas": [ { "nome": "Receita bruta", "tipo": "+", "valor": 0 }, { "nome": "Deduções", "tipo": "-", "valor": 0 }, { "nome": "Receita líquida", "tipo": "=", "valor": 0 }, { "nome": "Custos operacionais", "tipo": "-", "valor": 0 }, { "nome": "Despesas operacionais", "tipo": "-", "valor": 0 }, { "nome": "Lucro operacional", "tipo": "=", "valor": 0 }, { "nome": "Receitas financeiras", "tipo": "+", "valor": 0 }, { "nome": "Despesas financeiras", "tipo": "-", "valor": 0 }, { "nome": "Outras receitas", "tipo": "+", "valor": 0 }, { "nome": "Outras despesas", "tipo": "-", "valor": 0 }, { "nome": "Lucro/prejuízo", "tipo": "=", "valor": 0 } ] }, "itens": [ { "id": "1340", "nome": "Receita bruta", "tipo": "+", "padrao": "", "categoria_id": "", "nivel": 1, "categorias": [], "movimentacoes": { "2026-09": 0, "total": 0 } }, { "id": "1341", "nome": "Receitas de vendas", "categoria_id": "1340", "padrao": "", "tipo": "+", "nivel": 2, "categorias": [], "movimentacoes": { "2026-09": 0, "total": 0 } } ], "periodos": [ { "chave": "2026-09", "valor": "Set/2026" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/dre_gerencial", "x-periodo": { "data": "o mês da data de movimentação (ou de competência com tipo_data=DC); conta meses inteiros, do mês de data_inicio ao de data_fim", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda receita, despesas e resultado juntos, com os meses de data.periodos. data.totais.resultado é a última linha \"=\" do DRE (Lucro/prejuízo no DRE padrão) e data.totais.linhas traz as linhas de nível 1 com o total do período. NUNCA some linhas: as de tipo \"=\" já são acumuladas e as de nível 2 (em data.itens) repetem o valor que está na linha de nível 1. Linhas \"-\" vêm negativas: cite como custo/despesa. Inclui lançamentos em aberto (use baixado=pg para só o realizado). O período é sempre em meses inteiros. Sem movimento as linhas vêm zeradas. Este É o DRE gerencial da tela (Financeiro > Relatórios > DRE): não existe outro endpoint dre_gerencial. Para receitas e despesas por plano de contas (o relatório \"Plano de contas\" da tela, sem as linhas do DRE) use /relatorios/plano_contas. Sem previstas=1 só entram lançamentos que existem; com ele entram também as ocorrências previstas das contas fixas — data.totais.previstas diz se a empresa tem (disponiveis), se entraram (incluidas), quantas e quanto somaram: avise que parte do valor é previsão. Valores podem vir com muitas casas decimais (ex.: 2442.1633333): arredonde para 2 casas ao responder.", "description": "Demonstrativo de resultado (DRE gerencial) por mês: cada linha do DRE da empresa (Receita bruta, Deduções, Receita líquida, Custos, Despesas, Lucro/prejuízo…) com o valor de cada mês e o total do período. É a mesma regra da tela DRE gerencial.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram o mês da data de movimentação (ou de competência com tipo_data=DC); conta meses inteiros, do mês de data_inicio ao de data_fim. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/dre_gerencial` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/envios_cobranca": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar envios de cobrança", "operationId": "financeiro_relatorio_envios_cobranca_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_envios_cobranca", "x-operacao": "listar", "parameters": [ { "name": "cliente_id", "in": "query", "required": false, "description": "int — envios feitos a este cliente. Informe cliente_id, movimentacao_id ou os dois — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "movimentacao_id", "in": "query", "required": false, "description": "int — envios de um lançamento (id de /recebimentos ou /pagamentos)", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "cliente_id": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "visualizados": { "type": "integer" }, "por_canal": { "type": "object", "properties": { "whatsapp": { "type": "integer" }, "email": { "type": "integer" } } }, "por_situacao": { "type": "object", "properties": { "enviado": { "type": "integer" }, "visualizado": { "type": "integer" } } } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "movimentacao_id": { "type": "string" }, "canal": { "type": "string" }, "situacao": { "type": "string" }, "enviado_em": { "type": "string" }, "visualizado_em": { "type": [ "string", "null" ] }, "assunto": { "type": "string" }, "mensagem": { "type": "string" }, "enviado_por": { "type": "string" }, "nome_destinatario": { "type": "string" }, "contato_destinatario": { "type": "string" }, "observacao": { "type": [ "string", "null" ] }, "loja_id": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "cliente_id": "58634" }, "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": true }, "data": { "totais": { "quantidade": 2, "visualizados": 1, "por_canal": { "whatsapp": 1, "email": 1 }, "por_situacao": { "enviado": 1, "visualizado": 1 } }, "itens": [ { "id": "2", "movimentacao_id": "133623423", "canal": "whatsapp", "situacao": "enviado", "enviado_em": "2026-10-21 08:00:00", "visualizado_em": null, "assunto": "Cobrança TESTE API", "mensagem": "Lembrete de vencimento (teste).", "enviado_por": "Usuário Teste API", "nome_destinatario": "Cliente TESTE SR", "contato_destinatario": "(00) 90000-0000", "observacao": null, "loja_id": "65" }, { "id": "1", "movimentacao_id": "133623423", "canal": "email", "situacao": "visualizado", "enviado_em": "2026-10-15 09:12:00", "visualizado_em": "2026-10-15 10:40:00", "assunto": "Cobrança TESTE API", "mensagem": "Olá, segue a cobrança de teste.", "enviado_por": "Usuário Teste API", "nome_destinatario": "Cliente TESTE SR", "contato_destinatario": "cliente-teste-sr@example.com", "observacao": null, "loja_id": "65" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_recebimento (por movimentacao_id de um pagamento: Financeiro/MovimentacoesFinanceiras/index_pagamento)", "x-ia": "Use para \"a cobrança foi enviada?\" / \"o cliente viu o boleto?\". Cada item é um envio: canal (email, whatsapp, sms), situacao (enviado, visualizado, erro…), enviado_em e visualizado_em (vazio = o cliente ainda não abriu). Mais recente primeiro; vêm no máximo os 100 envios mais recentes de cada loja. data.totais conta os envios (quantidade, visualizados, por_canal, por_situacao). Não há período: é o histórico de envios. Esta consulta não envia nada; para mandar ou reenviar a cobrança, oriente a usar a tela do lançamento.", "description": "Histórico das cobranças enviadas ao cliente por e-mail, WhatsApp ou SMS, com quando foi enviada e se o cliente visualizou. Por cliente ou por lançamento. É a mesma regra da aba Envios da visualização do cliente e do lançamento. Só leitura: enviar ou reenviar a cobrança fica na tela.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_recebimento (por movimentacao_id de um pagamento: Financeiro/MovimentacoesFinanceiras/index_pagamento)` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/extrato": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar extrato financeiro", "operationId": "financeiro_relatorio_extrato_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_extrato", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "movimentacao", "in": "query", "required": false, "description": "C = só recebimentos (entradas), D = só pagamentos (saídas); sem ele entram os dois", "schema": { "type": "string" } }, { "name": "saldo_anterior", "in": "query", "required": false, "description": "1 = soma o saldo das contas antes de data_inicio (só lançamentos baixados) em saldo_anterior, saldo_atual e saldo_previsto; sem ele saldo_anterior vem 0 e os saldos são só o movimento do período (pesa mais na consulta)", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação personalizada da movimentação (situacao_id e situacao_nome vêm nas linhas deste relatório; /recebimentos e /pagamentos não trazem a situação)", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); categoria pai inclui as filhas; com rateio, só a parte rateada", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = baixado (pago/recebido); sem ele entram todos", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "saldo_anterior": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "saldo_anterior": { "type": "integer" }, "entradas": { "type": "integer" }, "saidas": { "type": "integer" }, "recebido": { "type": "integer" }, "a_receber": { "type": "integer" }, "pago": { "type": "integer" }, "a_pagar": { "type": "integer" }, "saldo_atual": { "type": "integer" }, "saldo_previsto": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "identificacao_parcela": { "type": [ "string", "null" ] }, "compra_id": { "type": [ "string", "null" ] }, "pedido_id": { "type": "string" }, "contrato_id": { "type": [ "string", "null" ] }, "nome_categoria": { "type": [ "string", "null" ] }, "nome_forma_pagamento": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "data_fluxo": { "type": "string" }, "data_emissao": { "type": "string" }, "data_vencimento": { "type": "string" }, "juros": { "type": "integer" }, "desconto": { "type": "integer" }, "taxa_banco": { "type": "integer" }, "taxa_operadora": { "type": "integer" }, "valor": { "type": "integer" }, "valor_total": { "type": "integer" }, "baixado": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_loja": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "cliente_id": { "type": "string" }, "transportadora_id": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_cliente": { "type": "string" }, "nome_fornecedor": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "outros": { "type": [ "string", "null" ] }, "nota_fiscal_id": { "type": [ "string", "null" ] }, "nota_fiscal_servico_id": { "type": [ "string", "null" ] }, "possui_rateio": { "type": "boolean" }, "categorias_agrupadas": { "type": "integer" }, "centros_custos_agrupados": { "type": "integer" }, "situacao_nome": { "type": "string" }, "situacao_cor": { "type": "string" }, "situacao_classe": { "type": "string" }, "classeTipo": { "type": "string" }, "data": { "type": "string" }, "descricao_entidade": { "type": "string" }, "fornecedor_pj_cnpj": { "type": "string" }, "fornecedor_pf_cpf": { "type": "string" }, "fornecedor_es_documento": { "type": "string" }, "cliente_pf_cpf": { "type": "string" }, "cliente_pj_cnpj": { "type": "string" }, "cliente_es_documento": { "type": "string" }, "transportadora_pf_cpf": { "type": "string" }, "transportadora_pj_cnpj": { "type": "string" }, "funcionario_cpf": { "type": "string" }, "rateio_centros_custos": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "descricao_quantidade": { "type": "string" }, "nomes": { "type": "string" }, "nomes_array": { "type": "object", "properties": [] } } }, "dadosTratados": { "type": "object", "properties": { "documento": { "type": "string" }, "destinado": { "type": "string" }, "descricao": { "type": "string" }, "planoContas": { "type": [ "string", "null" ] }, "centroCusto": { "type": "string" }, "nota_fiscal": { "type": "string" }, "nota_fiscal_servico": { "type": "string" }, "valor_formatado": { "type": "string" } } }, "categorias": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "categoria_id": { "type": [ "string", "null" ] }, "nome_categoria": { "type": [ "string", "null" ] }, "porcentagem": { "type": [ "string", "null" ] }, "porcentagem_real": { "type": [ "string", "null" ] }, "valor_total": { "type": [ "string", "null" ] } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "saldo_anterior": "1" }, "total_registros": 13, "pagina": 1, "limite": 2, "total_paginas": 7, "cache": true }, "data": { "totais": { "quantidade": 13, "saldo_anterior": 0, "entradas": 3530, "saidas": 0, "recebido": 230, "a_receber": 3300, "pago": 0, "a_pagar": 0, "saldo_atual": 230, "saldo_previsto": 3530 }, "itens": [ { "id": "133623354", "nome": "Venda de nº 9", "codigo": "3119", "tipo": "C", "identificacao_parcela": null, "compra_id": null, "pedido_id": "7060", "contrato_id": null, "nome_categoria": null, "nome_forma_pagamento": "Dinheiro à Vista", "nome_conta_bancaria": "Caixa", "nome_centro_custo": "", "data_fluxo": "2026-09-24", "data_emissao": "2026-09-24", "data_vencimento": "2026-09-24", "juros": 0, "desconto": 0, "taxa_banco": 0, "taxa_operadora": 0, "valor": 215, "valor_total": 215, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "fornecedor_id": null, "cliente_id": "58634", "transportadora_id": null, "funcionario_id": null, "nome_cliente": "Cliente TESTE SR", "nome_fornecedor": null, "nome_transportadora": null, "nome_funcionario": null, "outros": null, "nota_fiscal_id": null, "nota_fiscal_servico_id": null, "possui_rateio": false, "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "situacao_nome": "Confirmado", "situacao_cor": "", "situacao_classe": "success", "classeTipo": "success", "data": "2026-09-24", "descricao_entidade": "Cliente TESTE SR", "fornecedor_pj_cnpj": "", "fornecedor_pf_cpf": "", "fornecedor_es_documento": "", "cliente_pf_cpf": "", "cliente_pj_cnpj": "", "cliente_es_documento": "", "transportadora_pf_cpf": "", "transportadora_pj_cnpj": "", "funcionario_cpf": "", "rateio_centros_custos": { "quantidade": 0, "descricao_quantidade": "0 centro de custos", "nomes": "", "nomes_array": [] }, "dadosTratados": { "documento": "", "destinado": "Cliente TESTE SR", "descricao": "Venda de nº 9", "planoContas": null, "centroCusto": "", "nota_fiscal": "", "nota_fiscal_servico": "", "valor_formatado": "+ 215.00" }, "categorias": { "id": null, "categoria_id": null, "nome_categoria": null, "porcentagem": null, "porcentagem_real": null, "valor_total": null } }, { "id": "133623355", "nome": "Venda de nº 10", "codigo": "3120", "tipo": "C", "identificacao_parcela": null, "compra_id": null, "pedido_id": "7061", "contrato_id": null, "nome_categoria": null, "nome_forma_pagamento": "Dinheiro à Vista", "nome_conta_bancaria": "Caixa", "nome_centro_custo": "", "data_fluxo": "2026-09-25", "data_emissao": "2026-09-25", "data_vencimento": "2026-09-25", "juros": 0, "desconto": 0, "taxa_banco": 0, "taxa_operadora": 0, "valor": 15, "valor_total": 15, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "fornecedor_id": null, "cliente_id": null, "transportadora_id": null, "funcionario_id": null, "nome_cliente": null, "nome_fornecedor": null, "nome_transportadora": null, "nome_funcionario": null, "outros": null, "nota_fiscal_id": null, "nota_fiscal_servico_id": null, "possui_rateio": false, "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "situacao_nome": "Confirmado", "situacao_cor": "", "situacao_classe": "success", "classeTipo": "success", "data": "2026-09-25", "descricao_entidade": "", "fornecedor_pj_cnpj": "", "fornecedor_pf_cpf": "", "fornecedor_es_documento": "", "cliente_pf_cpf": "", "cliente_pj_cnpj": "", "cliente_es_documento": "", "transportadora_pf_cpf": "", "transportadora_pj_cnpj": "", "funcionario_cpf": "", "rateio_centros_custos": { "quantidade": 0, "descricao_quantidade": "0 centro de custos", "nomes": "", "nomes_array": [] }, "dadosTratados": { "documento": "", "destinado": "", "descricao": "Venda de nº 10", "planoContas": null, "centroCusto": "", "nota_fiscal": "", "nota_fiscal_servico": "", "valor_formatado": "+ 15.00" }, "categorias": { "id": null, "categoria_id": null, "nome_categoria": null, "porcentagem": null, "porcentagem_real": null, "valor_total": null } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/fluxo_caixa", "x-periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda quantidade, entradas, saídas e saldo juntos, citando o período e as lojas. saldo_atual = realizado (saldo_anterior + recebido − pago); saldo_previsto inclui o que está em aberto — podem ter sinais opostos: diga qual usou. Sem saldo_anterior=1 os saldos são só o resultado do período, nunca o saldo da conta: para \"quanto tenho em caixa\" mande saldo_anterior=1 ou use /relatorios/contas_bancarias. saidas vem em valor positivo. data.itens é só uma página — nunca some as linhas.", "description": "Extrato do período (pagar e receber juntos) já somado — entradas, saídas, recebido, a receber, pago, a pagar, saldo anterior, saldo atual (realizado) e saldo previsto — e a lista dos lançamentos. É a mesma regra do relatório de extrato da tela.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; data da baixa quando baixado). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/fluxo_caixa` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/fluxo_caixa": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar fluxo de caixa", "operationId": "financeiro_relatorio_fluxo_caixa_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_fluxo_caixa", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "movimentacao", "in": "query", "required": false, "description": "C = só recebimentos, D = só pagamentos; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "exibir_transferencia", "in": "query", "required": false, "description": "0 = tira as transferências entre contas; padrão 1", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação personalizada da movimentação (situacao_id e situacao_nome vêm nas linhas deste relatório; /recebimentos e /pagamentos não trazem a situação)", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "int — plano de contas (ids em /planos_contas); categoria pai inclui as filhas; com rateio, só a parte rateada", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo (ids em /centros_custos)", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int — conta bancária (ids em /contas_bancarias)", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int — forma de pagamento (ids em /formas_pagamentos)", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = baixado (pago/recebido); sem ele entram todos", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "receitas": { "type": "integer" }, "despesas": { "type": "integer" }, "recebido": { "type": "integer" }, "a_receber": { "type": "integer" }, "pago": { "type": "integer" }, "a_pagar": { "type": "integer" }, "resultado_realizado": { "type": "integer" }, "resultado_previsto": { "type": "integer" }, "media_mensal": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "tipo": { "type": "string" }, "nome": { "type": "string" }, "codigo": { "type": "string" }, "identificacao_parcela": { "type": [ "string", "null" ] }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "compra_id": { "type": [ "string", "null" ] }, "pedido_id": { "type": "string" }, "categoria_id": { "type": [ "string", "null" ] }, "nome_categoria": { "type": [ "string", "null" ] }, "centro_custo_id": { "type": [ "string", "null" ] }, "nome_centro_custo": { "type": "string" }, "data_fluxo": { "type": "string" }, "data_emissao": { "type": "string" }, "valor_total": { "type": "integer" }, "baixado": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_loja": { "type": "string" }, "nome_cliente": { "type": "string" }, "nome_fornecedor": { "type": [ "string", "null" ] }, "nome_transportadora": { "type": [ "string", "null" ] }, "nome_funcionario": { "type": [ "string", "null" ] }, "outros": { "type": [ "string", "null" ] }, "possui_rateio": { "type": "boolean" }, "categorias_agrupadas": { "type": "integer" }, "centros_custos_agrupados": { "type": "integer" }, "categorias": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "categoria_id": { "type": [ "string", "null" ] }, "nome_categoria": { "type": [ "string", "null" ] }, "porcentagem": { "type": [ "string", "null" ] }, "porcentagem_real": { "type": [ "string", "null" ] }, "valor_total": { "type": [ "string", "null" ] } } } } } }, "meses": { "type": "array", "items": { "type": "object", "properties": { "mes": { "type": "string" }, "receitas": { "type": "integer" }, "despesas": { "type": "integer" }, "resultado": { "type": "integer" } } } }, "receitas_por_categoria": { "type": "array", "items": { "type": "object", "properties": { "categoria_id": { "type": "string" }, "nome": { "type": "string" }, "valor": { "type": "integer" } } } }, "despesas_por_categoria": { "type": "object", "properties": [] }, "contas_bancarias": { "type": "array", "items": { "type": "object", "properties": { "conta_bancaria_id": { "type": "string" }, "nome": { "type": "string" }, "valor": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-08-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 13, "pagina": 1, "limite": 2, "total_paginas": 7, "cache": true }, "data": { "totais": { "receitas": 3530, "despesas": 0, "recebido": 230, "a_receber": 3300, "pago": 0, "a_pagar": 0, "resultado_realizado": 230, "resultado_previsto": 3530, "media_mensal": 1765 }, "itens": [ { "id": "133623354", "tipo": "C", "nome": "Venda de nº 9", "codigo": "3119", "identificacao_parcela": null, "conta_bancaria_id": "1", "nome_conta_bancaria": "Caixa", "nome_forma_pagamento": "Dinheiro à Vista", "compra_id": null, "pedido_id": "7060", "categoria_id": null, "nome_categoria": null, "centro_custo_id": null, "nome_centro_custo": "", "data_fluxo": "2026-09-24", "data_emissao": "2026-09-24", "valor_total": 215, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "nome_cliente": "Cliente TESTE SR", "nome_fornecedor": null, "nome_transportadora": null, "nome_funcionario": null, "outros": null, "possui_rateio": false, "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "categorias": { "id": null, "categoria_id": null, "nome_categoria": null, "porcentagem": null, "porcentagem_real": null, "valor_total": null } }, { "id": "133623355", "tipo": "C", "nome": "Venda de nº 10", "codigo": "3120", "identificacao_parcela": null, "conta_bancaria_id": "1", "nome_conta_bancaria": "Caixa", "nome_forma_pagamento": "Dinheiro à Vista", "compra_id": null, "pedido_id": "7061", "categoria_id": null, "nome_categoria": null, "centro_custo_id": null, "nome_centro_custo": "", "data_fluxo": "2026-09-25", "data_emissao": "2026-09-25", "valor_total": 15, "baixado": "1", "situacao_id": "281", "nome_loja": "11", "nome_cliente": null, "nome_fornecedor": null, "nome_transportadora": null, "nome_funcionario": null, "outros": null, "possui_rateio": false, "categorias_agrupadas": 0, "centros_custos_agrupados": 0, "categorias": { "id": null, "categoria_id": null, "nome_categoria": null, "porcentagem": null, "porcentagem_real": null, "valor_total": null } } ], "meses": [ { "mes": "2026-08", "receitas": 0, "despesas": 0, "resultado": 0 }, { "mes": "2026-09", "receitas": 3530, "despesas": 0, "resultado": 3530 } ], "receitas_por_categoria": [ { "categoria_id": "", "nome": "Sem plano de contas", "valor": 3530 } ], "despesas_por_categoria": [], "contas_bancarias": [ { "conta_bancaria_id": "1", "nome": "Caixa", "valor": 3530 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/fluxo_caixa", "x-periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "É o previsto contra o realizado do período: resultado_realizado = recebido − pago e resultado_previsto = receitas − despesas (inclui o que está em aberto). Não traz saldo de contas (parte de zero): para saldo use /relatorios/extrato com saldo_anterior=1 ou /relatorios/contas_bancarias. data.meses traz receitas, despesas e resultado de cada mês (cite todos, inclusive os zerados); data.receitas_por_categoria, data.despesas_por_categoria e data.contas_bancarias são as quebras. Todo filtro vale para os totais: diga o recorte usado. data.itens é só uma página — nunca some as linhas. Valores podem vir com muitas casas decimais (ex.: 2442.1633333): arredonde para 2 casas ao responder.", "description": "Fluxo de caixa do período — receitas, despesas, recebido, a receber, pago, a pagar, resultado realizado e previsto e média mensal já somados — com a série mês a mês, as quebras por plano de contas e por conta bancária e a lista dos lançamentos. É a mesma regra do fluxo de caixa da tela (modo estatísticas).\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; data da baixa quando baixado). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/fluxo_caixa` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/movimentacoes_cliente": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar movimentações de um cliente", "operationId": "financeiro_relatorio_movimentacoes_cliente_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_movimentacoes_cliente", "x-operacao": "listar", "parameters": [ { "name": "cliente_id", "in": "query", "required": false, "description": "int — obrigatório. Id do cliente — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — opcional, junto com data_fim: filtra pela data de fluxo (vencimento; data da baixa quando baixado). Sem as duas entra o histórico inteiro do cliente. Máximo 12 meses", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — opcional, junto com data_inicio", "schema": { "type": "string" } }, { "name": "busca", "in": "query", "required": false, "description": "string — trecho da descrição do lançamento", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "cliente_id": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valor_vencido": { "type": "integer" }, "valor_a_vencer": { "type": "integer" }, "valor_pago": { "type": "number" }, "valor_em_aberto": { "type": "integer" }, "valor_total": { "type": "number" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "descricao": { "type": "string" }, "data_fluxo": { "type": "string" }, "valor_total": { "type": "integer" }, "baixado": { "type": "boolean" }, "situacao_id": { "type": "string" }, "situacao": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "boleto": { "type": "boolean" }, "cartao": { "type": "boolean" }, "pix": { "type": "boolean" }, "loja_id": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "cliente_id": "58634" }, "total_registros": 14, "pagina": 1, "limite": 2, "total_paginas": 7, "cache": true }, "data": { "totais": { "quantidade": 14, "valor_vencido": 3650, "valor_a_vencer": 0, "valor_pago": 335.5, "valor_em_aberto": 3650, "valor_total": 3985.5 }, "itens": [ { "id": "133623423", "descricao": "Boleto TESTE API aberto", "data_fluxo": "2026-10-20", "valor_total": 350, "baixado": false, "situacao_id": "280", "situacao": "Atrasado", "nome_forma_pagamento": "Boleto TESTE API", "boleto": true, "cartao": false, "pix": false, "loja_id": "65" }, { "id": "133623424", "descricao": "Boleto TESTE API recebido", "data_fluxo": "2026-10-11", "valor_total": 120.5, "baixado": true, "situacao_id": "281", "situacao": "Confirmado", "nome_forma_pagamento": "Boleto TESTE API", "boleto": true, "cartao": false, "pix": false, "loja_id": "65" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_recebimento", "x-ia": "Use para \"quanto o cliente X me deve\" / \"o cliente está em dia?\". Sem data_inicio/data_fim vem o histórico inteiro do cliente (não é o mês atual) — é o que responde dívida em aberto. data.totais já vem somado: valor_em_aberto = valor_vencido + valor_a_vencer (o que falta receber); valor_vencido é só o que venceu ANTES de hoje (o que vence hoje está em valor_a_vencer); valor_pago é o já recebido; valor_total soma tudo, pagos inclusive — não chame valor_total de dívida. Só contas a receber (tipo C), não pagamentos ao cliente. data.itens é só uma página (mais recente primeiro): nunca some as linhas. situacao já diz Atrasado quando venceu sem baixa. Para o histórico de um lançamento use /recebimentos/{id}/historico; para as cobranças enviadas, /relatorios/envios_cobranca.", "description": "Contas a receber de um cliente com o resumo do que está vencido, a vencer, pago e em aberto. É a mesma regra da aba Financeiro da visualização do cliente.\n\n**Campos obrigatórios:** `cliente_id`\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_recebimento` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/pesquisa_movimentacoes": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar pesquisa de movimentações", "operationId": "financeiro_relatorio_pesquisa_movimentacoes_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_pesquisa_movimentacoes", "x-operacao": "listar", "parameters": [ { "name": "busca", "in": "query", "required": false, "description": "string — obrigatório. Trecho da descrição, do nome ou do documento; busca por palavras (início de palavra)", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "C = só contas a receber, D = só contas a pagar; sem ele procura nas duas (as de pagar só entram se o usuário tiver a permissão de listar pagamentos)", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "filtros": { "type": "object", "properties": { "busca": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "identificacao_parcela": { "type": "string" }, "nome_cliente": { "type": "string" }, "nome_fornecedor": { "type": "string" }, "nome_transportadora": { "type": "string" }, "nome_funcionario": { "type": "string" }, "outros": { "type": "string" }, "categoria_id": { "type": "string" }, "nome_categoria": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "conta_bancaria_id": { "type": "string" }, "nome_conta_bancaria": { "type": "string" }, "data_fluxo": { "type": "string" }, "valor_total": { "type": "integer" }, "tipo": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "filtros": { "busca": "venda" }, "total_registros": 13, "pagina": 1, "limite": 2, "total_paginas": 7, "cache": true }, "data": { "totais": { "quantidade": 13 }, "itens": [ { "id": "133623354", "codigo": "3119", "nome": "Venda de nº 9", "identificacao_parcela": "", "nome_cliente": "Cliente TESTE SR", "nome_fornecedor": "", "nome_transportadora": "", "nome_funcionario": "", "outros": "", "categoria_id": "", "nome_categoria": "", "forma_pagamento_id": "646904", "nome_forma_pagamento": "Dinheiro à Vista", "conta_bancaria_id": "1", "nome_conta_bancaria": "Caixa", "data_fluxo": "2026-09-24", "valor_total": 215, "tipo": "C" }, { "id": "133623355", "codigo": "3120", "nome": "Venda de nº 10", "identificacao_parcela": "", "nome_cliente": "", "nome_fornecedor": "", "nome_transportadora": "", "nome_funcionario": "", "outros": "", "categoria_id": "", "nome_categoria": "", "forma_pagamento_id": "646904", "nome_forma_pagamento": "Dinheiro à Vista", "conta_bancaria_id": "1", "nome_conta_bancaria": "Caixa", "data_fluxo": "2026-09-25", "valor_total": 15, "tipo": "C" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/index_recebimento (com tipo=D: Financeiro/MovimentacoesFinanceiras/index_pagamento)", "x-ia": "Use quando a pessoa cita uma conta pelo nome e não se sabe se é a pagar ou a receber; para totais de um período use /relatorios/contas_pagar ou /relatorios/contas_receber. Não há recorte de período: a busca varre todo o histórico. data.totais.quantidade é o número de lançamentos encontrados; data.itens é só uma página.", "description": "Busca por texto em contas a pagar e a receber ao mesmo tempo — descrição, nome do cliente/fornecedor ou documento — sem recorte de período. Cada linha diz o tipo (C = receber, D = pagar). É a mesma busca da tela de conciliação de extrato.\n\n**Campos obrigatórios:** `busca`\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/index_recebimento (com tipo=D: Financeiro/MovimentacoesFinanceiras/index_pagamento)` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/plano_contas": { "get": { "tags": [ "Financeiro" ], "summary": "Consultar receitas e despesas por plano de contas", "operationId": "financeiro_relatorio_plano_contas_listar", "x-modulo": "financeiro", "x-recurso": "relatorio_plano_contas", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de fluxo, ou de emissão com tipo_data=emissao)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo_data", "in": "query", "required": false, "description": "fluxo (padrão) ou emissao — qual data o período recorta", "schema": { "type": "string" } }, { "name": "movimentacao", "in": "query", "required": false, "description": "C = só recebimentos (receitas), D = só pagamentos (despesas); sem ele entram os dois", "schema": { "type": "string" } }, { "name": "baixado", "in": "query", "required": false, "description": "ab = em aberto, at = atrasado (em aberto com data de fluxo antes de hoje), pg = baixado (pago/recebido); sem ele entram todos", "schema": { "type": "string" } }, { "name": "categoria_id", "in": "query", "required": false, "description": "planos de contas; plano pai inclui os filhos; com rateio, só a parte rateada — ids em `/planos_contas` — aceita vários: `categoria_id=1,2` ou `categoria_id[]=1&categoria_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "centros de custo — ids em `/centros_custos` — aceita vários: `centro_custo_id=1,2` ou `centro_custo_id[]=1¢ro_custo_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "contas bancárias — ids em `/contas_bancarias` — aceita vários: `conta_bancaria_id=1,2` ou `conta_bancaria_id[]=1&conta_bancaria_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "formas de pagamento — ids em `/formas_pagamentos` — aceita vários: `forma_pagamento_id=1,2` ou `forma_pagamento_id[]=1&forma_pagamento_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (ids em /clientes)", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor (ids em /fornecedores)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int — situação personalizada da movimentação (o situacao_id vem nas linhas de /relatorios/contas_receber e /relatorios/contas_pagar)", "schema": { "type": "string" } }, { "name": "busca", "in": "query", "required": false, "description": "texto — parte da descrição do lançamento", "schema": { "type": "string" } }, { "name": "exibir_transferencia", "in": "query", "required": false, "description": "1 = inclui as transferências entre contas; padrão 0 (fora), como a tela", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade_planos": { "type": "integer" }, "receitas": { "type": "number" }, "despesas": { "type": "integer" }, "resultado": { "type": "number" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "classificacao": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "nivel": { "type": "integer" }, "quantidade": { "type": "integer" }, "valor": { "type": "number" } } } }, "lojas": { "type": "array", "items": { "type": "object", "properties": { "loja_id": { "type": "string" }, "resultado": { "type": "number" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "data de fluxo (vencimento; data da baixa quando baixado)", "inicio": "2026-01-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 5, "total_paginas": 1, "cache": true }, "data": { "totais": { "quantidade_planos": 1, "receitas": 470.5, "despesas": 0, "resultado": 470.5 }, "itens": [ { "id": "12866599", "classificacao": "", "nome": "Receitas TESTE SR", "tipo": "C", "nivel": 2, "quantidade": 2, "valor": 470.5 } ], "lojas": [ { "loja_id": "65", "resultado": 470.5 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Financeiro/MovimentacoesFinanceiras/dre_gerencial", "x-periodo": { "data": "a data de fluxo (vencimento; data da baixa quando baixado); com tipo_data=emissao, a data de emissão (competência)", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Use para \"quanto entrou/saiu em cada plano de contas\" ou \"qual plano de contas mais gastou\". data.totais.receitas e data.totais.despesas são os cards da tela (já somados, sem contar duas vezes o plano pai) e data.totais.resultado = receitas − despesas; quantidade_planos conta as linhas. Em data.itens: tipo C = receita, D = despesa, valor SEM sinal (o sentido está em tipo); nivel 1 = plano pai, que já soma os filhos (nivel 2) logo abaixo dele — NUNCA some pai e filhos. quantidade = lançamentos daquele plano. Entra só lançamento com plano de contas e plano marcado para aparecer no DRE (\"disponível no DRE\" no cadastro); em aberto entra junto (use baixado=pg para só o realizado). data.lojas traz o resultado de cada loja. NÃO é o DRE gerencial: /relatorios/dre soma por linha do demonstrativo (Receita bruta, Deduções, Lucro/prejuízo…) e mês a mês; este soma por plano de contas, no período inteiro. Também não é o /relatorios/fluxo_caixa, que traz receitas/despesas por plano junto com recebido × a receber, pago × a pagar, a série mês a mês e conta todo lançamento (inclusive sem plano). data.itens é só uma página (máx. 100) — os totais são do período inteiro.", "description": "Receitas e despesas do período somadas por plano de contas — cada plano com a classificação, o tipo (receita ou despesa), a quantidade de lançamentos e o valor —, com os cards de receitas, despesas e resultado e o resultado por loja. É a mesma regra do relatório \"Plano de contas\" da tela (Financeiro > Relatórios > Plano de contas).\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de fluxo (vencimento; data da baixa quando baixado); com tipo_data=emissao, a data de emissão (competência). Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Financeiro/MovimentacoesFinanceiras/dre_gerencial` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_produtos": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar notas fiscais de produtos", "operationId": "fiscal_notas_fiscais_produtos_listar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_produtos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — data de emissão (vai junto com data_fim)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — data de emissão", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "número da nota (numero_nf da resposta, não o id)", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "0 = Em aberto, 1 = Aprovada, 2 = Reprovada, 3 = Denegada, 4 = Cancelada, 5 = Enviando, 6 = Corrigida — aceita vários: `situacao=1,2` ou `situacao[]=1&situacao[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "tipo", "in": "query", "required": false, "description": "0 = entrada, 1 = saída", "schema": { "type": "string" } }, { "name": "documento", "in": "query", "required": false, "description": "CPF ou CNPJ do destinatário, com ou sem máscara", "schema": { "type": "string" } }, { "name": "entidade", "in": "query", "required": false, "description": "nome do destinatário: uma palavra acha pelo começo de qualquer palavra do nome (ex.: cli); com várias palavras, cada uma precisa ser palavra inteira do nome", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja (a chave precisa acessá-la; senão 403); sem loja_id e sem loja, só a loja da chave, não todas", "schema": { "type": "string" } }, { "name": "loja", "in": "query", "required": false, "description": "deixe vazio (loja=) para todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "ncm", "in": "query", "required": false, "description": "começo do NCM de algum item da nota", "schema": { "type": "string" } }, { "name": "natureza", "in": "query", "required": false, "description": "id da natureza de operação (/naturezas_operacoes)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "pedido_id": { "type": "string" }, "compra_id": { "type": "string" }, "chave": { "type": "string" }, "protocolo": { "type": "string" }, "cfop_id": { "type": "string" }, "codigo_cfop": { "type": "string" }, "descricao_cfop": { "type": "string" }, "natureza_operacao": { "type": "string" }, "indicador_pagamento": { "type": "string" }, "modelo": { "type": "string" }, "serie": { "type": "string" }, "numero_nf": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "tipo_nf": { "type": "string" }, "indicador_destinatario": { "type": "string" }, "cidade_id": { "type": "string" }, "cidade_nome": { "type": "string" }, "codigo_uf": { "type": "string" }, "tipo_emissao": { "type": "string" }, "tipo_ambiente": { "type": "string" }, "finalidade_nf": { "type": "string" }, "consumidor_final": { "type": "string" }, "tipo_atendimento": { "type": "string" }, "tipo_documento_emitente": { "type": "string" }, "cnpj_emitente": { "type": "string" }, "cpf_emitente": { "type": "string" }, "nome_emitente": { "type": "string" }, "fantasia_emitente": { "type": "string" }, "logradouro_emitente": { "type": "string" }, "numero_emitente": { "type": "string" }, "complemento_emitente": { "type": "string" }, "bairro_emitente": { "type": "string" }, "codigo_municipio_emitente": { "type": "string" }, "municipio_emitente": { "type": "string" }, "uf_emitente": { "type": "string" }, "cep_emitente": { "type": "string" }, "codigo_pais_emitente": { "type": "string" }, "pais_emitente": { "type": "string" }, "telefone_emitente": { "type": "string" }, "ie_emitente": { "type": "string" }, "iest_emitente": { "type": "string" }, "im_emitente": { "type": "string" }, "destinatario_id": { "type": "string" }, "destinatario_nome": { "type": "string" }, "destinatario_fornecedor_id": { "type": "string" }, "destinatario_fornecedor_nome": { "type": "string" }, "destinatario_tipo_documento": { "type": "string" }, "destinatario_cnpj": { "type": "string" }, "destinatario_cpf": { "type": "string" }, "destinatario_id_estrangeiro": { "type": "string" }, "destinatario_logradouro": { "type": "string" }, "destinatario_numero": { "type": "string" }, "destinatario_complemento": { "type": "string" }, "destinatario_bairro": { "type": "string" }, "destinatario_cidade_id": { "type": "string" }, "destinatario_municipio_codigo": { "type": "string" }, "destinatario_municipio_nome": { "type": "string" }, "destinatario_uf": { "type": "string" }, "destinatario_cep": { "type": "string" }, "destinatario_pais_codigo": { "type": "string" }, "destinatario_pais_nome": { "type": "string" }, "destinatario_telefone": { "type": "string" }, "destinatario_ie": { "type": "string" }, "destinatario_im": { "type": "string" }, "destinatario_email": { "type": [ "string", "null" ] }, "valor_total_nf": { "type": "string" }, "base_icms": { "type": "string" }, "valor_icms": { "type": "string" }, "valor_fcp": { "type": "string" }, "base_icms_st": { "type": "string" }, "valor_icms_st": { "type": "string" }, "valor_fcp_st": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_seguro": { "type": "string" }, "valor_desconto": { "type": "string" }, "valor_outros": { "type": "string" }, "valor_imposto_importacao": { "type": "string" }, "valor_ipi": { "type": "string" }, "valor_ipi_devolvido": { "type": "string" }, "valor_pis": { "type": "string" }, "valor_cofins": { "type": "string" }, "valor_icms_desonerado": { "type": "string" }, "valor_fcp_st_retido": { "type": "string" }, "valor_fcp_uf_destino": { "type": "string" }, "valor_icms_uf_remetente": { "type": "string" }, "informacoes_complementares": { "type": "string" }, "situacao_nf": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "codigo_produto": { "type": "string" }, "nome_produto": { "type": "string" }, "cfop": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "estoque_id": { "type": "string" }, "ncm_id": { "type": "string" }, "NCM": { "type": "string" }, "tipo": { "type": "string" }, "altura": { "type": "string" }, "largura": { "type": "string" }, "codigo_barras": { "type": "string" } } } }, "pagamento": { "type": "array", "items": { "type": "object", "properties": { "numero_duplicata": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor_pagamento": { "type": "string" }, "tipo_pagamento": { "type": "string" }, "codigo_autorizacao": { "type": "string" }, "cnpj_credenciadora": { "type": "string" }, "bandeira_cartao": { "type": "string" }, "valor_troco": { "type": "string" } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "total_paginas": 1, "total_registros_pagina": 2, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1707", "empresa_id": "24", "loja_id": "80764", "nome_loja": "11", "pedido_id": "", "compra_id": "", "chave": "", "protocolo": "", "cfop_id": "289", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "natureza_operacao": "Vendas", "indicador_pagamento": "0", "modelo": "55", "serie": "1", "numero_nf": "90", "data_emissao": "2025-07-17", "hora_emissao": "11:51:00", "tipo_nf": "1", "indicador_destinatario": "1", "cidade_id": "1411", "cidade_nome": "Belo Horizonte (MG)", "codigo_uf": "31", "tipo_emissao": "1", "tipo_ambiente": "1", "finalidade_nf": "1", "consumidor_final": "1", "tipo_atendimento": "1", "tipo_documento_emitente": "PJ", "cnpj_emitente": "", "cpf_emitente": "", "nome_emitente": "", "fantasia_emitente": "", "logradouro_emitente": "", "numero_emitente": "", "complemento_emitente": "", "bairro_emitente": "", "codigo_municipio_emitente": "", "municipio_emitente": "", "uf_emitente": "", "cep_emitente": "", "codigo_pais_emitente": "1058", "pais_emitente": "Brasil", "telefone_emitente": "", "ie_emitente": "", "iest_emitente": "", "im_emitente": "", "destinatario_id": "58796", "destinatario_nome": "Maria Aline Freitas teste", "destinatario_fornecedor_id": "", "destinatario_fornecedor_nome": "", "destinatario_tipo_documento": "PF", "destinatario_cnpj": "", "destinatario_cpf": "314.248.614-38", "destinatario_id_estrangeiro": "", "destinatario_logradouro": "Rua teste", "destinatario_numero": "1235", "destinatario_complemento": "", "destinatario_bairro": "Bairro", "destinatario_cidade_id": "1411", "destinatario_municipio_codigo": "3106200", "destinatario_municipio_nome": "Belo Horizonte", "destinatario_uf": "MG", "destinatario_cep": "31000-000", "destinatario_pais_codigo": "1058", "destinatario_pais_nome": "Brasil", "destinatario_telefone": "(67)3776-0000", "destinatario_ie": "", "destinatario_im": "", "destinatario_email": null, "valor_total_nf": "48.00", "base_icms": "48.00", "valor_icms": "8.64", "valor_fcp": "0.96", "base_icms_st": "0.00", "valor_icms_st": "0.00", "valor_fcp_st": "0.00", "valor_produtos": "48.00", "valor_frete": "0.00", "valor_seguro": "0.00", "valor_desconto": "0.00", "valor_outros": "0.00", "valor_imposto_importacao": "0.00", "valor_ipi": "0.00", "valor_ipi_devolvido": "0.00", "valor_pis": "0.00", "valor_cofins": "0.00", "valor_icms_desonerado": "0.00", "valor_fcp_st_retido": "0.00", "valor_fcp_uf_destino": "0.00", "valor_icms_uf_remetente": "0.00", "informacoes_complementares": "teste de informações complementares", "situacao_nf": "Em aberto", "cadastrado_em": "2025-07-21 11:39:59", "modificado_em": "2025-07-21 17:44:54", "produtos": [ { "produto_id": "32291", "codigo_produto": "20283550680090001", "nome_produto": "Produto - Azul e Cinza", "cfop": "5102", "unidade": "UND", "quantidade": "3.00", "valor_venda": "48.00", "estoque_id": "295400", "ncm_id": "14643", "NCM": "00000000", "tipo": "P", "altura": "", "largura": "", "codigo_barras": "" } ], "pagamento": [ { "numero_duplicata": "1", "forma_pagamento_id": "641207", "data_vencimento": "16/07/2025", "valor_pagamento": "10.00", "tipo_pagamento": "BB", "codigo_autorizacao": "12345", "cnpj_credenciadora": "", "bandeira_cartao": "", "valor_troco": "" } ] }, { "id": "1629", "empresa_id": "24", "loja_id": "80764", "nome_loja": "11", "pedido_id": "", "compra_id": "", "chave": "00000000000000000000000000000000000000000000", "protocolo": "131256740870000", "cfop_id": "289", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "natureza_operacao": "Vendas", "indicador_pagamento": "0", "modelo": "55", "serie": "1", "numero_nf": "39", "data_emissao": "2025-06-25", "hora_emissao": "09:42:00", "tipo_nf": "1", "indicador_destinatario": "1", "cidade_id": "1411", "cidade_nome": "Belo Horizonte", "codigo_uf": "31", "tipo_emissao": "1", "tipo_ambiente": "1", "finalidade_nf": "1", "consumidor_final": "1", "tipo_atendimento": "0", "tipo_documento_emitente": "PJ", "cnpj_emitente": "00.000.000/0001-00", "cpf_emitente": "", "nome_emitente": "EMPRESA MATERIAIS LTDA", "fantasia_emitente": "EMPRESA", "logradouro_emitente": "AV AVENIDA TESTE", "numero_emitente": "1400", "complemento_emitente": "", "bairro_emitente": "BAIRRO", "codigo_municipio_emitente": "3106200", "municipio_emitente": "Belo Horizonte", "uf_emitente": "MG", "cep_emitente": "30000-000", "codigo_pais_emitente": "1058", "pais_emitente": "Brasil", "telefone_emitente": "(31)0000-0000", "ie_emitente": "123456", "iest_emitente": "", "im_emitente": "456123", "destinatario_id": "58796", "destinatario_nome": "Maria Aline Freitas teste", "destinatario_fornecedor_id": "", "destinatario_fornecedor_nome": "", "destinatario_tipo_documento": "PF", "destinatario_cnpj": "", "destinatario_cpf": "314.248.614-38", "destinatario_id_estrangeiro": "", "destinatario_logradouro": "Rua teste", "destinatario_numero": "1235", "destinatario_complemento": "", "destinatario_bairro": "Bairro", "destinatario_cidade_id": "1411", "destinatario_municipio_codigo": "3106200", "destinatario_municipio_nome": "Belo Horizonte", "destinatario_uf": "MG", "destinatario_cep": "31000-000", "destinatario_pais_codigo": "1058", "destinatario_pais_nome": "Brasil", "destinatario_telefone": "(67)3776-0000", "destinatario_ie": "", "destinatario_im": "", "destinatario_email": null, "valor_total_nf": "10.00", "base_icms": "0.00", "valor_icms": "0.00", "valor_fcp": "0.00", "base_icms_st": "0.00", "valor_icms_st": "0.00", "valor_fcp_st": "0.00", "valor_produtos": "10.00", "valor_frete": "0.00", "valor_seguro": "0.00", "valor_desconto": "0.00", "valor_outros": "0.00", "valor_imposto_importacao": "0.00", "valor_ipi": "0.00", "valor_ipi_devolvido": "0.00", "valor_pis": "0.00", "valor_cofins": "0.00", "valor_icms_desonerado": "0.00", "valor_fcp_st_retido": "0.00", "valor_fcp_uf_destino": "0.00", "valor_icms_uf_remetente": "0.00", "informacoes_complementares": "teste de informações complementares", "situacao_nf": "Aprovada", "cadastrado_em": "2025-06-25 12:42:58", "modificado_em": "2025-06-25 12:43:23", "produtos": [ { "produto_id": "23418", "codigo_produto": "2023337182605", "nome_produto": "Produto TesteZ", "cfop": "5102", "unidade": "UND", "quantidade": "1.00", "valor_venda": "10.00", "estoque_id": "289024", "ncm_id": "14643", "NCM": "00000000", "tipo": "P", "altura": "", "largura": "", "codigo_barras": "" } ], "pagamento": [] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de emissão da nota", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Só NF-e (modelo 55); NFC-e fica em notas_fiscais_consumidores e NFS-e em notas_fiscais_servicos — são documentos diferentes e não se somam. situacao_nf vem por extenso: responda por ele. Para total emitido e impostos do período use relatorio_nfe, já somado. Sem loja_id/loja, só entram as notas da loja da chave; e só as do ambiente (produção ou homologação) configurado na loja. Usuário sem a permissão de ver notas de outros usuários só enxerga as que ele emitiu. Cada item já traz produtos e pagamento (é o mesmo conteúdo de GET /notas_fiscais_produtos/{id}). destinatario_email não vem preenchido pela API. Nota emitida é faturamento, não dinheiro recebido (financeiro) nem soma de pedidos (vendas). A resposta não traz link do DANFE nem do XML: para baixar, oriente a tela de NF-e.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da nota. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Notas fiscais" ], "summary": "Cadastrar notas fiscais de produtos", "operationId": "fiscal_notas_fiscais_produtos_cadastrar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_produtos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal cadastrada com sucesso.", "dados": "223", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`valor_frete` é o frete do cabeçalho: o sistema rateia o valor entre os produtos proporcionalmente ao valor de cada item (o último recebe a diferença de arredondamento), soma em `valor_frete` dos totais e inclui no valor total da nota. Use ponto como separador decimal (`150.50`). A modalidade do frete é derivada (por conta do emitente) — ainda não é configurável pela API.\n\n**Campos obrigatórios:** `loja_id`, `tipo_nf`, `id_destinatario`, `produtos`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loja_id": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "data_entrada_saida": { "type": "string" }, "hora_entrada_saida": { "type": "string" }, "id_destinatario": { "type": "integer" }, "informacoes_complementares": { "type": "string" }, "tipo_atendimento": { "type": "integer" }, "tipo_nf": { "type": "integer" }, "envio_automatico": { "type": "integer" }, "indicador_final": { "type": "integer" }, "valor_frete": { "type": "number" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "quantidade": { "type": "integer" }, "NCM": { "type": "string" } } } }, "pagamento": { "type": "array", "items": { "type": "object", "properties": { "forma_pagamento_id": { "type": "integer" }, "codigo_autorizacao": { "type": "integer" }, "valor_pagamento": { "type": "integer" }, "data_vencimento": { "type": "string" } } } } } }, "example": { "loja_id": "80764", "data_emissao": "17/07/2025", "hora_emissao": "11:51", "data_entrada_saida": "17/07/2025", "hora_entrada_saida": "11:51:00", "id_destinatario": 58796, "informacoes_complementares": "teste de informações complementares", "tipo_atendimento": 2, "tipo_nf": 1, "envio_automatico": 0, "indicador_final": 1, "valor_frete": 150.5, "produtos": [ { "produto_id": 32291, "variacao_id": 6023952, "quantidade": 3, "NCM": "00000000" } ], "pagamento": [ { "forma_pagamento_id": 641207, "codigo_autorizacao": 12345, "valor_pagamento": 10, "data_vencimento": "16/07/2025" } ] } } } } } }, "/notas_fiscais_produtos/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Visualizar notas fiscais de produtos", "operationId": "fiscal_notas_fiscais_produtos_visualizar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_produtos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "pedido_id": { "type": "string" }, "compra_id": { "type": "string" }, "chave": { "type": "string" }, "protocolo": { "type": "string" }, "cfop_id": { "type": "string" }, "codigo_cfop": { "type": "string" }, "descricao_cfop": { "type": "string" }, "natureza_operacao": { "type": "string" }, "indicador_pagamento": { "type": "string" }, "modelo": { "type": "string" }, "serie": { "type": "string" }, "numero_nf": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "tipo_nf": { "type": "string" }, "indicador_destinatario": { "type": "string" }, "cidade_id": { "type": "string" }, "cidade_nome": { "type": "string" }, "codigo_uf": { "type": "string" }, "tipo_emissao": { "type": "string" }, "tipo_ambiente": { "type": "string" }, "finalidade_nf": { "type": "string" }, "consumidor_final": { "type": "string" }, "tipo_atendimento": { "type": "string" }, "tipo_documento_emitente": { "type": "string" }, "cnpj_emitente": { "type": "string" }, "cpf_emitente": { "type": "string" }, "nome_emitente": { "type": "string" }, "fantasia_emitente": { "type": "string" }, "logradouro_emitente": { "type": "string" }, "numero_emitente": { "type": "string" }, "complemento_emitente": { "type": "string" }, "bairro_emitente": { "type": "string" }, "codigo_municipio_emitente": { "type": "string" }, "municipio_emitente": { "type": "string" }, "uf_emitente": { "type": "string" }, "cep_emitente": { "type": "string" }, "codigo_pais_emitente": { "type": "string" }, "pais_emitente": { "type": "string" }, "telefone_emitente": { "type": "string" }, "ie_emitente": { "type": "string" }, "iest_emitente": { "type": "string" }, "im_emitente": { "type": "string" }, "destinatario_id": { "type": "string" }, "destinatario_nome": { "type": "string" }, "destinatario_fornecedor_id": { "type": "string" }, "destinatario_fornecedor_nome": { "type": "string" }, "destinatario_tipo_documento": { "type": "string" }, "destinatario_cnpj": { "type": "string" }, "destinatario_cpf": { "type": "string" }, "destinatario_id_estrangeiro": { "type": "string" }, "destinatario_logradouro": { "type": "string" }, "destinatario_numero": { "type": "string" }, "destinatario_complemento": { "type": "string" }, "destinatario_bairro": { "type": "string" }, "destinatario_cidade_id": { "type": "string" }, "destinatario_municipio_codigo": { "type": "string" }, "destinatario_municipio_nome": { "type": "string" }, "destinatario_uf": { "type": "string" }, "destinatario_cep": { "type": "string" }, "destinatario_pais_codigo": { "type": "string" }, "destinatario_pais_nome": { "type": "string" }, "destinatario_telefone": { "type": "string" }, "destinatario_ie": { "type": "string" }, "destinatario_im": { "type": "string" }, "destinatario_email": { "type": [ "string", "null" ] }, "valor_total_nf": { "type": "string" }, "base_icms": { "type": "string" }, "valor_icms": { "type": "string" }, "valor_fcp": { "type": "string" }, "base_icms_st": { "type": "string" }, "valor_icms_st": { "type": "string" }, "valor_fcp_st": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_seguro": { "type": "string" }, "valor_desconto": { "type": "string" }, "valor_outros": { "type": "string" }, "valor_imposto_importacao": { "type": "string" }, "valor_ipi": { "type": "string" }, "valor_ipi_devolvido": { "type": "string" }, "valor_pis": { "type": "string" }, "valor_cofins": { "type": "string" }, "valor_icms_desonerado": { "type": "string" }, "valor_fcp_st_retido": { "type": "string" }, "valor_fcp_uf_destino": { "type": "string" }, "valor_icms_uf_remetente": { "type": "string" }, "informacoes_complementares": { "type": "string" }, "situacao_nf": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "codigo_produto": { "type": "string" }, "nome_produto": { "type": "string" }, "cfop": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "estoque_id": { "type": "string" }, "ncm_id": { "type": "string" }, "NCM": { "type": "string" }, "tipo": { "type": "string" }, "altura": { "type": "string" }, "largura": { "type": "string" }, "codigo_barras": { "type": "string" } } } }, "pagamento": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1592", "empresa_id": "24", "loja_id": "80764", "nome_loja": "11", "pedido_id": "", "compra_id": "", "chave": "00000000000000000000000000000000000000000000", "protocolo": "000000000", "cfop_id": "289", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "natureza_operacao": "5102 - Vendas", "indicador_pagamento": "0", "modelo": "55", "serie": "1", "numero_nf": "4", "data_emissao": "2025-06-12", "hora_emissao": "13:49:00", "tipo_nf": "1", "indicador_destinatario": "1", "cidade_id": "2262", "cidade_nome": "Ribas do Rio Pardo", "codigo_uf": "50", "tipo_emissao": "1", "tipo_ambiente": "2", "finalidade_nf": "1", "consumidor_final": "1", "tipo_atendimento": "1", "tipo_documento_emitente": "PJ", "cnpj_emitente": "85.222.312/0001-00", "cpf_emitente": "", "nome_emitente": "EMITENTE TESTE", "fantasia_emitente": "EMITENTE FANTASIA", "logradouro_emitente": "RUA TESTE", "numero_emitente": "S/N", "complemento_emitente": "LOTE 17 QUADRA 03", "bairro_emitente": "BAIRRO TESTE", "codigo_municipio_emitente": "5007109", "municipio_emitente": "Ribas do Rio Pardo", "uf_emitente": "MS", "cep_emitente": "00000-000", "codigo_pais_emitente": "1058", "pais_emitente": "Brasil", "telefone_emitente": "(67)0000-0000", "ie_emitente": "000000", "iest_emitente": "", "im_emitente": "123456", "destinatario_id": "58797", "destinatario_nome": "LUIZ TESTE DA SILVA", "destinatario_fornecedor_id": "", "destinatario_fornecedor_nome": "", "destinatario_tipo_documento": "PF", "destinatario_cnpj": "", "destinatario_cpf": "201.797.290-80", "destinatario_id_estrangeiro": "", "destinatario_logradouro": "Rua Teste", "destinatario_numero": "1154", "destinatario_complemento": "", "destinatario_bairro": "Bairro dest", "destinatario_cidade_id": "1417", "destinatario_municipio_codigo": "3106705", "destinatario_municipio_nome": "Betim", "destinatario_uf": "MG", "destinatario_cep": "00000-088", "destinatario_pais_codigo": "1058", "destinatario_pais_nome": "Brasil", "destinatario_telefone": "", "destinatario_ie": "", "destinatario_im": "", "destinatario_email": null, "valor_total_nf": "10.00", "base_icms": "0.00", "valor_icms": "0.00", "valor_fcp": "0.00", "base_icms_st": "0.00", "valor_icms_st": "0.00", "valor_fcp_st": "0.00", "valor_produtos": "10.00", "valor_frete": "0.00", "valor_seguro": "0.00", "valor_desconto": "0.00", "valor_outros": "0.00", "valor_imposto_importacao": "0.00", "valor_ipi": "0.00", "valor_ipi_devolvido": "0.00", "valor_pis": "0.00", "valor_cofins": "0.00", "valor_icms_desonerado": "0.00", "valor_fcp_st_retido": "0.00", "valor_fcp_uf_destino": "0.00", "valor_icms_uf_remetente": "0.00", "informacoes_complementares": "", "situacao_nf": "Aprovada", "cadastrado_em": "2025-06-12 13:49:36", "modificado_em": "2025-06-12 13:57:20", "produtos": [ { "produto_id": "32246", "codigo_produto": "012345689", "nome_produto": "ABRACADEIRA 10X16X9MM", "cfop": "5102", "unidade": "UN", "quantidade": "1.00", "valor_venda": "10.00", "estoque_id": "295375", "ncm_id": "11541", "NCM": "73261900", "tipo": "P", "altura": "", "largura": "", "codigo_barras": "" } ], "pagamento": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Mesmo formato de um item da listagem: situacao_nf por extenso, produtos e pagamento. Um id de NFC-e aqui dá 404: procure em notas_fiscais_consumidores. Não traz link do DANFE nem o XML: para baixar, oriente a tela de NF-e.", "description": "404 quando a nota não existe, é de outra empresa, de uma loja que o usuário da chave não acessa ou é NFC-e (modelo 65).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Notas fiscais" ], "summary": "Editar notas fiscais de produtos", "operationId": "fiscal_notas_fiscais_produtos_editar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_produtos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal atualizada com sucesso.", "dados": "216", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`valor_frete` é o frete do cabeçalho: o sistema rateia o valor entre os produtos proporcionalmente ao valor de cada item (o último recebe a diferença de arredondamento), soma em `valor_frete` dos totais e inclui no valor total da nota. Use ponto como separador decimal (`150.50`). A modalidade do frete é derivada (por conta do emitente) — ainda não é configurável pela API.\n\n**Campos obrigatórios:** `loja_id`, `tipo_nf`, `id_destinatario`, `produtos`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loja_id": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "data_entrada_saida": { "type": "string" }, "hora_entrada_saida": { "type": "string" }, "id_fornecedor": { "type": "integer" }, "informacoes_complementares": { "type": "string" }, "tipo_atendimento": { "type": "integer" }, "tipo_nf": { "type": "integer" }, "envio_automatico": { "type": "integer" }, "indicador_final": { "type": "integer" }, "valor_frete": { "type": "number" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "valor_custo": { "type": "integer" }, "valor_venda": { "type": "integer" }, "quantidade": { "type": "integer" }, "NCM": { "type": "string" } } } }, "pagamento": { "type": "array", "items": { "type": "object", "properties": { "forma_pagamento_id": { "type": "integer" }, "codigo_autorizacao": { "type": "integer" }, "valor_pagamento": { "type": "integer" }, "data_vencimento": { "type": "string" } } } } } }, "example": { "loja_id": "80764", "data_emissao": "18/07/2025", "hora_emissao": "11:51", "data_entrada_saida": "18/07/2025", "hora_entrada_saida": "11:51:00", "id_fornecedor": 548, "informacoes_complementares": "teste de informações complementares", "tipo_atendimento": 9, "tipo_nf": 0, "envio_automatico": 1, "indicador_final": 1, "valor_frete": 150.5, "produtos": [ { "produto_id": 32291, "variacao_id": 6023952, "valor_custo": 10, "valor_venda": 20, "quantidade": 3, "NCM": "00000000" } ], "pagamento": [ { "forma_pagamento_id": 641207, "codigo_autorizacao": 12345, "valor_pagamento": 10, "data_vencimento": "20/07/2025" } ] } } } } }, "delete": { "tags": [ "Notas fiscais" ], "summary": "Deletar notas fiscais de produtos", "operationId": "fiscal_notas_fiscais_produtos_deletar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_produtos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "boolean" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota deletada com sucesso.", "dados": false, "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_produtos/emitir/{id}": { "post": { "tags": [ "Notas fiscais" ], "summary": "Emitir notas fiscais de produtos", "operationId": "fiscal_notas_fiscais_produtos_emitir", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_produtos", "x-operacao": "emitir", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal emitida com sucesso!", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "sefaz" ], "description": "**Efeito fora do sistema:** transmite o documento à SEFAZ. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_produtos/cancelar/{id}": { "post": { "tags": [ "Notas fiscais" ], "summary": "Cancelar notas fiscais de produtos", "operationId": "fiscal_notas_fiscais_produtos_cancelar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_produtos", "x-operacao": "cancelar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal cancelada com sucesso.", "dados": "216", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "sefaz" ], "description": "**Efeito fora do sistema:** transmite o documento à SEFAZ. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "motivo": { "type": "string" } } }, "example": { "motivo": "Teste de cancelamento via webservice." } } } } } }, "/notas_fiscais_consumidores": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar notas fiscais de consumidores", "operationId": "fiscal_notas_fiscais_consumidores_listar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_consumidores", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — data de emissão (vai junto com data_fim)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — data de emissão", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "número da nota (numero_nf da resposta, não o id)", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "0 = Em aberto, 1 = Aprovada, 2 = Reprovada, 3 = Denegada, 4 = Cancelada, 5 = Enviando, 6 = Corrigida — aceita vários: `situacao=1,2` ou `situacao[]=1&situacao[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "documento", "in": "query", "required": false, "description": "CPF ou CNPJ do consumidor, com ou sem máscara", "schema": { "type": "string" } }, { "name": "ncm", "in": "query", "required": false, "description": "começo do NCM de algum item da nota", "schema": { "type": "string" } }, { "name": "natureza", "in": "query", "required": false, "description": "id da natureza de operação (/naturezas_operacoes)", "schema": { "type": "string" } }, { "name": "entidade", "in": "query", "required": false, "description": "nome do consumidor: uma palavra acha pelo começo de qualquer palavra do nome (ex.: cli); com várias palavras, cada uma precisa ser palavra inteira do nome", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja (a chave precisa acessá-la; senão 403); sem loja_id e sem loja, só a loja da chave, não todas", "schema": { "type": "string" } }, { "name": "loja", "in": "query", "required": false, "description": "deixe vazio (loja=) para todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "pedido_id": { "type": "string" }, "compra_id": { "type": "string" }, "chave": { "type": "string" }, "protocolo": { "type": "string" }, "cfop_id": { "type": "string" }, "codigo_cfop": { "type": "string" }, "descricao_cfop": { "type": "string" }, "natureza_operacao": { "type": "string" }, "indicador_pagamento": { "type": "string" }, "modelo": { "type": "string" }, "serie": { "type": "string" }, "numero_nf": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "tipo_nf": { "type": "string" }, "indicador_destinatario": { "type": "string" }, "cidade_id": { "type": "string" }, "cidade_nome": { "type": "string" }, "codigo_uf": { "type": "string" }, "tipo_emissao": { "type": "string" }, "tipo_ambiente": { "type": "string" }, "finalidade_nf": { "type": "string" }, "consumidor_final": { "type": "string" }, "tipo_atendimento": { "type": "string" }, "tipo_documento_emitente": { "type": "string" }, "cnpj_emitente": { "type": "string" }, "cpf_emitente": { "type": "string" }, "nome_emitente": { "type": "string" }, "fantasia_emitente": { "type": "string" }, "logradouro_emitente": { "type": "string" }, "numero_emitente": { "type": "string" }, "complemento_emitente": { "type": "string" }, "bairro_emitente": { "type": "string" }, "codigo_municipio_emitente": { "type": "string" }, "municipio_emitente": { "type": "string" }, "uf_emitente": { "type": "string" }, "cep_emitente": { "type": "string" }, "codigo_pais_emitente": { "type": "string" }, "pais_emitente": { "type": "string" }, "telefone_emitente": { "type": "string" }, "ie_emitente": { "type": "string" }, "iest_emitente": { "type": "string" }, "im_emitente": { "type": "string" }, "destinatario_id": { "type": "string" }, "destinatario_nome": { "type": "string" }, "destinatario_fornecedor_id": { "type": "string" }, "destinatario_fornecedor_nome": { "type": "string" }, "destinatario_tipo_documento": { "type": "string" }, "destinatario_cnpj": { "type": "string" }, "destinatario_cpf": { "type": "string" }, "destinatario_id_estrangeiro": { "type": "string" }, "destinatario_logradouro": { "type": "string" }, "destinatario_numero": { "type": "string" }, "destinatario_complemento": { "type": "string" }, "destinatario_bairro": { "type": "string" }, "destinatario_cidade_id": { "type": "string" }, "destinatario_municipio_codigo": { "type": "string" }, "destinatario_municipio_nome": { "type": "string" }, "destinatario_uf": { "type": "string" }, "destinatario_cep": { "type": "string" }, "destinatario_pais_codigo": { "type": "string" }, "destinatario_pais_nome": { "type": "string" }, "destinatario_telefone": { "type": "string" }, "destinatario_ie": { "type": "string" }, "destinatario_im": { "type": "string" }, "destinatario_email": { "type": [ "string", "null" ] }, "valor_total_nf": { "type": "string" }, "base_icms": { "type": "string" }, "valor_icms": { "type": "string" }, "valor_fcp": { "type": "string" }, "base_icms_st": { "type": "string" }, "valor_icms_st": { "type": "string" }, "valor_fcp_st": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_seguro": { "type": "string" }, "valor_desconto": { "type": "string" }, "valor_outros": { "type": "string" }, "valor_imposto_importacao": { "type": "string" }, "valor_ipi": { "type": "string" }, "valor_ipi_devolvido": { "type": "string" }, "valor_pis": { "type": "string" }, "valor_cofins": { "type": "string" }, "valor_icms_desonerado": { "type": "string" }, "valor_fcp_st_retido": { "type": "string" }, "valor_fcp_uf_destino": { "type": "string" }, "valor_icms_uf_remetente": { "type": "string" }, "informacoes_complementares": { "type": "string" }, "situacao_nf": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "codigo_produto": { "type": "string" }, "nome_produto": { "type": "string" }, "cfop": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "estoque_id": { "type": "string" }, "ncm_id": { "type": "string" }, "NCM": { "type": "string" }, "tipo": { "type": "string" }, "altura": { "type": "string" }, "largura": { "type": "string" }, "codigo_barras": { "type": "string" } } } }, "pagamento": { "type": "object", "properties": [] } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 14, "total_paginas": 1, "total_registros_pagina": 14, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "1694", "empresa_id": "24", "loja_id": "80764", "nome_loja": "11", "pedido_id": "", "compra_id": "", "chave": "", "protocolo": "", "cfop_id": "289", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "natureza_operacao": "Vendas", "indicador_pagamento": "0", "modelo": "65", "serie": "2", "numero_nf": "49648", "data_emissao": "2025-07-17", "hora_emissao": "11:51:00", "tipo_nf": "1", "indicador_destinatario": "1", "cidade_id": "1411", "cidade_nome": "Belo Horizonte (MG)", "codigo_uf": "31", "tipo_emissao": "1", "tipo_ambiente": "2", "finalidade_nf": "1", "consumidor_final": "1", "tipo_atendimento": "1", "tipo_documento_emitente": "PJ", "cnpj_emitente": "", "cpf_emitente": "", "nome_emitente": "", "fantasia_emitente": "", "logradouro_emitente": "", "numero_emitente": "", "complemento_emitente": "", "bairro_emitente": "", "codigo_municipio_emitente": "", "municipio_emitente": "", "uf_emitente": "", "cep_emitente": "", "codigo_pais_emitente": "1058", "pais_emitente": "Brasil", "telefone_emitente": "", "ie_emitente": "", "iest_emitente": "", "im_emitente": "", "destinatario_id": "58796", "destinatario_nome": "Maria Aline Freitas teste", "destinatario_fornecedor_id": "", "destinatario_fornecedor_nome": "", "destinatario_tipo_documento": "PF", "destinatario_cnpj": "", "destinatario_cpf": "000.000.000-00", "destinatario_id_estrangeiro": "", "destinatario_logradouro": "Rua teste", "destinatario_numero": "1235", "destinatario_complemento": "", "destinatario_bairro": "Bairro", "destinatario_cidade_id": "1411", "destinatario_municipio_codigo": "3106200", "destinatario_municipio_nome": "Belo Horizonte", "destinatario_uf": "MG", "destinatario_cep": "30000-000", "destinatario_pais_codigo": "1058", "destinatario_pais_nome": "Brasil", "destinatario_telefone": "(67)0000-0000", "destinatario_ie": "", "destinatario_im": "", "destinatario_email": null, "valor_total_nf": "48.00", "base_icms": "48.00", "valor_icms": "8.64", "valor_fcp": "0.96", "base_icms_st": "0.00", "valor_icms_st": "0.00", "valor_fcp_st": "0.00", "valor_produtos": "48.00", "valor_frete": "0.00", "valor_seguro": "0.00", "valor_desconto": "0.00", "valor_outros": "0.00", "valor_imposto_importacao": "0.00", "valor_ipi": "0.00", "valor_ipi_devolvido": "0.00", "valor_pis": "0.00", "valor_cofins": "0.00", "valor_icms_desonerado": "0.00", "valor_fcp_st_retido": "0.00", "valor_fcp_uf_destino": "0.00", "valor_icms_uf_remetente": "0.00", "informacoes_complementares": "teste de informações complementares", "situacao_nf": "Em aberto", "cadastrado_em": "2025-07-17 18:12:43", "modificado_em": "2025-07-17 18:12:43", "produtos": [ { "produto_id": "32290", "codigo_produto": "2044993077807", "nome_produto": "produto", "cfop": "5102", "unidade": "UND", "quantidade": "3.00", "valor_venda": "48.00", "estoque_id": "295395", "ncm_id": "14643", "NCM": "00000000", "tipo": "P", "altura": "", "largura": "", "codigo_barras": "" } ], "pagamento": [] }, { "id": "1652", "empresa_id": "24", "loja_id": "80764", "nome_loja": "11", "pedido_id": "", "compra_id": "", "chave": "00000000000000000000000000000000000000000000", "protocolo": "000000000", "cfop_id": "289", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "natureza_operacao": "Vendas", "indicador_pagamento": "0", "modelo": "65", "serie": "2", "numero_nf": "49641", "data_emissao": "2025-06-30", "hora_emissao": "13:45:58", "tipo_nf": "1", "indicador_destinatario": "1", "cidade_id": "1411", "cidade_nome": "Belo Horizonte", "codigo_uf": "31", "tipo_emissao": "1", "tipo_ambiente": "2", "finalidade_nf": "1", "consumidor_final": "1", "tipo_atendimento": "1", "tipo_documento_emitente": "PJ", "cnpj_emitente": "00.000.000/0001-00", "cpf_emitente": "", "nome_emitente": "EMPRESA MATERIAIS LTDA", "fantasia_emitente": "EMPRESA", "logradouro_emitente": "AV TESTE", "numero_emitente": "1400", "complemento_emitente": "", "bairro_emitente": "BAIRRO", "codigo_municipio_emitente": "3106200", "municipio_emitente": "Belo Horizonte", "uf_emitente": "MG", "cep_emitente": "30000-000", "codigo_pais_emitente": "1058", "pais_emitente": "Brasil", "telefone_emitente": "(31)0000-0000", "ie_emitente": "00000.00-0", "iest_emitente": "", "im_emitente": "123456", "destinatario_id": "58796", "destinatario_nome": "Maria Aline Freitas teste", "destinatario_fornecedor_id": "", "destinatario_fornecedor_nome": "", "destinatario_tipo_documento": "PF", "destinatario_cnpj": "", "destinatario_cpf": "000.000.000-00", "destinatario_id_estrangeiro": "", "destinatario_logradouro": "Rua teste", "destinatario_numero": "1235", "destinatario_complemento": "", "destinatario_bairro": "Bairro", "destinatario_cidade_id": "1411", "destinatario_municipio_codigo": "3106200", "destinatario_municipio_nome": "Belo Horizonte", "destinatario_uf": "MG", "destinatario_cep": "30000-000", "destinatario_pais_codigo": "1058", "destinatario_pais_nome": "Brasil", "destinatario_telefone": "(67)0000-0000", "destinatario_ie": "", "destinatario_im": "", "destinatario_email": null, "valor_total_nf": "16.00", "base_icms": "0.00", "valor_icms": "0.00", "valor_fcp": "0.00", "base_icms_st": "0.00", "valor_icms_st": "0.00", "valor_fcp_st": "0.00", "valor_produtos": "16.00", "valor_frete": "0.00", "valor_seguro": "0.00", "valor_desconto": "0.00", "valor_outros": "0.00", "valor_imposto_importacao": "0.00", "valor_ipi": "0.00", "valor_ipi_devolvido": "0.00", "valor_pis": "0.00", "valor_cofins": "0.00", "valor_icms_desonerado": "0.00", "valor_fcp_st_retido": "0.00", "valor_fcp_uf_destino": "0.00", "valor_icms_uf_remetente": "0.00", "informacoes_complementares": "teste de informações complementares", "situacao_nf": "Cancelada", "cadastrado_em": "2025-06-30 13:42:43", "modificado_em": "2025-06-30 13:45:58", "produtos": [ { "produto_id": "23418", "codigo_produto": "2023337182605", "nome_produto": "aa06072022", "cfop": "5102", "unidade": "UND", "quantidade": "1.00", "valor_venda": "16.00", "estoque_id": "289024", "ncm_id": "14643", "NCM": "00000000", "tipo": "P", "altura": "", "largura": "", "codigo_barras": "" } ], "pagamento": [ { "numero_duplicata": "1", "forma_pagamento_id": "647285", "data_vencimento": "30/06/2025", "valor_pagamento": "10.00", "tipo_pagamento": "CC", "codigo_autorizacao": "", "cnpj_credenciadora": "00.000.000/0001-00", "bandeira_cartao": "01", "valor_troco": "" } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de emissão da nota", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Só NFC-e (modelo 65, cupom do consumidor); NF-e fica em notas_fiscais_produtos e NFS-e em notas_fiscais_servicos — não se somam. situacao_nf vem por extenso: responda por ele. Para total emitido no período use relatorio_nfce, já somado. Sem loja_id/loja, só entram as notas da loja da chave; e só as do ambiente (produção ou homologação) configurado na loja. Usuário sem a permissão de ver notas de outros usuários só enxerga as que ele emitiu. Cada item já traz produtos e pagamento (o mesmo conteúdo de GET /notas_fiscais_consumidores/{id}); em pagamento, data_vencimento vem DD/MM/AAAA. A resposta não traz link do DANFCE nem do XML: para baixar, oriente a tela de NFC-e.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da nota. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Notas fiscais" ], "summary": "Cadastrar notas fiscais de consumidores", "operationId": "fiscal_notas_fiscais_consumidores_cadastrar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_consumidores", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal cadastrada com sucesso.", "dados": "223", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`valor_frete` é o frete do cabeçalho: o sistema rateia o valor entre os produtos proporcionalmente ao valor de cada item (o último recebe a diferença de arredondamento), soma em `valor_frete` dos totais e inclui no valor total da nota. Use ponto como separador decimal (`30.00`). O caso de uso é a entrega a domicílio: envie junto `tipo_atendimento: 4`. Com frete a modalidade passa a ser \"por conta do emitente\"; sem frete continua \"sem ocorrência de transporte\". O endereço de entrega ainda não é informável pela API.\n\n**Campos obrigatórios:** `loja_id`, `produtos`, `pagamento`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loja_id": { "type": "string" }, "id_destinatario": { "type": "integer" }, "informacoes_complementares": { "type": "string" }, "tipo_atendimento": { "type": "integer" }, "tipo_nf": { "type": "string" }, "envio_automatico": { "type": "integer" }, "indicador_final": { "type": "integer" }, "valor_frete": { "type": "number" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "quantidade": { "type": "integer" }, "NCM": { "type": "string" } } } }, "pagamento": { "type": "array", "items": { "type": "object", "properties": { "forma_pagamento_id": { "type": "integer" }, "codigo_autorizacao": { "type": "integer" }, "valor_pagamento": { "type": "integer" }, "data_vencimento": { "type": "string" } } } } } }, "example": { "loja_id": "80764", "id_destinatario": 58796, "informacoes_complementares": "teste de informações complementares", "tipo_atendimento": 4, "tipo_nf": "1", "envio_automatico": 1, "indicador_final": 1, "valor_frete": 30, "produtos": [ { "produto_id": 32291, "variacao_id": 6023952, "quantidade": 3, "NCM": "00000000" } ], "pagamento": [ { "forma_pagamento_id": 641207, "codigo_autorizacao": 12345, "valor_pagamento": 10, "data_vencimento": "16/07/2025" } ] } } } } } }, "/notas_fiscais_consumidores/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Visualizar notas fiscais de consumidores", "operationId": "fiscal_notas_fiscais_consumidores_visualizar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_consumidores", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "pedido_id": { "type": "string" }, "compra_id": { "type": "string" }, "chave": { "type": "string" }, "protocolo": { "type": "string" }, "cfop_id": { "type": "string" }, "codigo_cfop": { "type": "string" }, "descricao_cfop": { "type": "string" }, "natureza_operacao": { "type": "string" }, "indicador_pagamento": { "type": "string" }, "modelo": { "type": "string" }, "serie": { "type": "string" }, "numero_nf": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "tipo_nf": { "type": "string" }, "indicador_destinatario": { "type": "string" }, "cidade_id": { "type": "string" }, "cidade_nome": { "type": "string" }, "codigo_uf": { "type": "string" }, "tipo_emissao": { "type": "string" }, "tipo_ambiente": { "type": "string" }, "finalidade_nf": { "type": "string" }, "consumidor_final": { "type": "string" }, "tipo_atendimento": { "type": "string" }, "tipo_documento_emitente": { "type": "string" }, "cnpj_emitente": { "type": "string" }, "cpf_emitente": { "type": "string" }, "nome_emitente": { "type": "string" }, "fantasia_emitente": { "type": "string" }, "logradouro_emitente": { "type": "string" }, "numero_emitente": { "type": "string" }, "complemento_emitente": { "type": "string" }, "bairro_emitente": { "type": "string" }, "codigo_municipio_emitente": { "type": "string" }, "municipio_emitente": { "type": "string" }, "uf_emitente": { "type": "string" }, "cep_emitente": { "type": "string" }, "codigo_pais_emitente": { "type": "string" }, "pais_emitente": { "type": "string" }, "telefone_emitente": { "type": "string" }, "ie_emitente": { "type": "string" }, "iest_emitente": { "type": "string" }, "im_emitente": { "type": "string" }, "destinatario_id": { "type": "string" }, "destinatario_nome": { "type": "string" }, "destinatario_fornecedor_id": { "type": "string" }, "destinatario_fornecedor_nome": { "type": "string" }, "destinatario_tipo_documento": { "type": "string" }, "destinatario_cnpj": { "type": "string" }, "destinatario_cpf": { "type": "string" }, "destinatario_id_estrangeiro": { "type": "string" }, "destinatario_logradouro": { "type": "string" }, "destinatario_numero": { "type": "string" }, "destinatario_complemento": { "type": "string" }, "destinatario_bairro": { "type": "string" }, "destinatario_cidade_id": { "type": "string" }, "destinatario_municipio_codigo": { "type": "string" }, "destinatario_municipio_nome": { "type": "string" }, "destinatario_uf": { "type": "string" }, "destinatario_cep": { "type": "string" }, "destinatario_pais_codigo": { "type": "string" }, "destinatario_pais_nome": { "type": "string" }, "destinatario_telefone": { "type": "string" }, "destinatario_ie": { "type": "string" }, "destinatario_im": { "type": "string" }, "destinatario_email": { "type": [ "string", "null" ] }, "valor_total_nf": { "type": "string" }, "base_icms": { "type": "string" }, "valor_icms": { "type": "string" }, "valor_fcp": { "type": "string" }, "base_icms_st": { "type": "string" }, "valor_icms_st": { "type": "string" }, "valor_fcp_st": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_seguro": { "type": "string" }, "valor_desconto": { "type": "string" }, "valor_outros": { "type": "string" }, "valor_imposto_importacao": { "type": "string" }, "valor_ipi": { "type": "string" }, "valor_ipi_devolvido": { "type": "string" }, "valor_pis": { "type": "string" }, "valor_cofins": { "type": "string" }, "valor_icms_desonerado": { "type": "string" }, "valor_fcp_st_retido": { "type": "string" }, "valor_fcp_uf_destino": { "type": "string" }, "valor_icms_uf_remetente": { "type": "string" }, "informacoes_complementares": { "type": "string" }, "situacao_nf": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "codigo_produto": { "type": "string" }, "nome_produto": { "type": "string" }, "cfop": { "type": "string" }, "unidade": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "estoque_id": { "type": "string" }, "ncm_id": { "type": "string" }, "NCM": { "type": "string" }, "tipo": { "type": "string" }, "altura": { "type": "string" }, "largura": { "type": "string" }, "codigo_barras": { "type": "string" } } } }, "pagamento": { "type": "array", "items": { "type": "object", "properties": { "numero_duplicata": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "data_vencimento": { "type": "string" }, "valor_pagamento": { "type": "string" }, "tipo_pagamento": { "type": "string" }, "codigo_autorizacao": { "type": "string" }, "cnpj_credenciadora": { "type": "string" }, "bandeira_cartao": { "type": "string" }, "valor_troco": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1652", "empresa_id": "24", "loja_id": "80764", "nome_loja": "11", "pedido_id": "", "compra_id": "", "chave": "00000000000000000000000000000000000000000000", "protocolo": "000000000", "cfop_id": "289", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "natureza_operacao": "Vendas", "indicador_pagamento": "0", "modelo": "65", "serie": "2", "numero_nf": "49641", "data_emissao": "2025-06-30", "hora_emissao": "13:45:58", "tipo_nf": "1", "indicador_destinatario": "1", "cidade_id": "1411", "cidade_nome": "Belo Horizonte", "codigo_uf": "31", "tipo_emissao": "1", "tipo_ambiente": "2", "finalidade_nf": "1", "consumidor_final": "1", "tipo_atendimento": "1", "tipo_documento_emitente": "PJ", "cnpj_emitente": "00.000.000/0001-00", "cpf_emitente": "", "nome_emitente": "EMPRESA MATERIAIS LTDA", "fantasia_emitente": "EMPRESA", "logradouro_emitente": "AV AVENIDA TESTE", "numero_emitente": "1400", "complemento_emitente": "", "bairro_emitente": "BAIRRO", "codigo_municipio_emitente": "3106200", "municipio_emitente": "Belo Horizonte", "uf_emitente": "MG", "cep_emitente": "30000-000", "codigo_pais_emitente": "1058", "pais_emitente": "Brasil", "telefone_emitente": "(31)0000-0000", "ie_emitente": "000000", "iest_emitente": "", "im_emitente": "123456", "destinatario_id": "58796", "destinatario_nome": "Maria Aline Freitas teste", "destinatario_fornecedor_id": "", "destinatario_fornecedor_nome": "", "destinatario_tipo_documento": "PF", "destinatario_cnpj": "", "destinatario_cpf": "000.000.000-00", "destinatario_id_estrangeiro": "", "destinatario_logradouro": "Rua teste", "destinatario_numero": "1235", "destinatario_complemento": "", "destinatario_bairro": "Bairro", "destinatario_cidade_id": "1411", "destinatario_municipio_codigo": "3106200", "destinatario_municipio_nome": "Belo Horizonte", "destinatario_uf": "MG", "destinatario_cep": "31000-040", "destinatario_pais_codigo": "1058", "destinatario_pais_nome": "Brasil", "destinatario_telefone": "(67)0000-0000", "destinatario_ie": "", "destinatario_im": "", "destinatario_email": null, "valor_total_nf": "16.00", "base_icms": "0.00", "valor_icms": "0.00", "valor_fcp": "0.00", "base_icms_st": "0.00", "valor_icms_st": "0.00", "valor_fcp_st": "0.00", "valor_produtos": "16.00", "valor_frete": "0.00", "valor_seguro": "0.00", "valor_desconto": "0.00", "valor_outros": "0.00", "valor_imposto_importacao": "0.00", "valor_ipi": "0.00", "valor_ipi_devolvido": "0.00", "valor_pis": "0.00", "valor_cofins": "0.00", "valor_icms_desonerado": "0.00", "valor_fcp_st_retido": "0.00", "valor_fcp_uf_destino": "0.00", "valor_icms_uf_remetente": "0.00", "informacoes_complementares": "teste de informações complementares", "situacao_nf": "Cancelada", "cadastrado_em": "2025-06-30 13:42:43", "modificado_em": "2025-06-30 13:45:58", "produtos": [ { "produto_id": "23418", "codigo_produto": "2023337182605", "nome_produto": "aa06072022", "cfop": "5102", "unidade": "UND", "quantidade": "1.00", "valor_venda": "16.00", "estoque_id": "289024", "ncm_id": "14643", "NCM": "00000000", "tipo": "P", "altura": "", "largura": "", "codigo_barras": "" } ], "pagamento": [ { "numero_duplicata": "1", "forma_pagamento_id": "647285", "data_vencimento": "30/06/2025", "valor_pagamento": "10.00", "tipo_pagamento": "CC", "codigo_autorizacao": "", "cnpj_credenciadora": "00.000.000/0001-00", "bandeira_cartao": "01", "valor_troco": "" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Mesmo formato de um item da listagem: situacao_nf por extenso, produtos e pagamento. Em pagamento, data_vencimento vem DD/MM/AAAA (as demais datas vêm AAAA-MM-DD). Um id de NF-e aqui dá 404: procure em notas_fiscais_produtos. Não traz link do DANFCE nem o XML.", "description": "404 quando a nota não existe, é de outra empresa, de uma loja que o usuário da chave não acessa ou é NF-e (modelo 55).", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Notas fiscais" ], "summary": "Editar notas fiscais de consumidores", "operationId": "fiscal_notas_fiscais_consumidores_editar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_consumidores", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal atualizada com sucesso.", "dados": "216", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`valor_frete` é o frete do cabeçalho: o sistema rateia o valor entre os produtos proporcionalmente ao valor de cada item (o último recebe a diferença de arredondamento), soma em `valor_frete` dos totais e inclui no valor total da nota. Use ponto como separador decimal (`30.00`). O caso de uso é a entrega a domicílio: envie junto `tipo_atendimento: 4`. Com frete a modalidade passa a ser \"por conta do emitente\"; sem frete continua \"sem ocorrência de transporte\". O endereço de entrega ainda não é informável pela API.\n\n**Campos obrigatórios:** `loja_id`, `produtos`, `pagamento`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loja_id": { "type": "string" }, "id_destinatario": { "type": "integer" }, "informacoes_complementares": { "type": "string" }, "tipo_atendimento": { "type": "integer" }, "tipo_nf": { "type": "string" }, "envio_automatico": { "type": "integer" }, "indicador_final": { "type": "integer" }, "valor_frete": { "type": "number" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "integer" }, "variacao_id": { "type": "integer" }, "quantidade": { "type": "integer" }, "NCM": { "type": "string" } } } }, "pagamento": { "type": "array", "items": { "type": "object", "properties": { "forma_pagamento_id": { "type": "integer" }, "codigo_autorizacao": { "type": "integer" }, "valor_pagamento": { "type": "integer" }, "data_vencimento": { "type": "string" } } } } } }, "example": { "loja_id": "80764", "id_destinatario": 58796, "informacoes_complementares": "teste de informações complementares", "tipo_atendimento": 4, "tipo_nf": "1", "envio_automatico": 1, "indicador_final": 1, "valor_frete": 30, "produtos": [ { "produto_id": 32291, "variacao_id": 6023952, "quantidade": 3, "NCM": "00000000" } ], "pagamento": [ { "forma_pagamento_id": 641207, "codigo_autorizacao": 12345, "valor_pagamento": 10, "data_vencimento": "16/07/2025" } ] } } } } }, "delete": { "tags": [ "Notas fiscais" ], "summary": "Deletar notas fiscais de consumidores", "operationId": "fiscal_notas_fiscais_consumidores_deletar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_consumidores", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "boolean" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota deletada com sucesso.", "dados": false, "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_consumidores/emitir/{id}": { "post": { "tags": [ "Notas fiscais" ], "summary": "Emitir notas fiscais de consumidores", "operationId": "fiscal_notas_fiscais_consumidores_emitir", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_consumidores", "x-operacao": "emitir", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal emitida com sucesso!", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "sefaz" ], "description": "**Efeito fora do sistema:** transmite o documento à SEFAZ. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_consumidores/cancelar/{id}": { "post": { "tags": [ "Notas fiscais" ], "summary": "Cancelar notas fiscais de consumidores", "operationId": "fiscal_notas_fiscais_consumidores_cancelar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_consumidores", "x-operacao": "cancelar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal cancelada com sucesso.", "dados": "216", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "sefaz" ], "description": "**Efeito fora do sistema:** transmite o documento à SEFAZ. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "motivo": { "type": "string" } } }, "example": { "motivo": "Teste de cancelamento via webservice." } } } } } }, "/notas_fiscais_servicos": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar notas fiscais de serviços", "operationId": "fiscal_notas_fiscais_servicos_listar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_servicos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — data de emissão (vai junto com data_fim)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — data de emissão", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "número da NFS-e dado pela prefeitura (só existe depois de aprovada)", "schema": { "type": "string" } }, { "name": "rps", "in": "query", "required": false, "description": "número do RPS (é o campo codigo da resposta)", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "0 = Em aberto, 1 = Enviando, 2 = Aprovada, 3 = Reprovada, 4 = Cancelada, 5 = Denegada (a tabela é diferente da NF-e) — aceita vários: `situacao=1,2` ou `situacao[]=1&situacao[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "documento", "in": "query", "required": false, "description": "CPF ou CNPJ do tomador, com ou sem máscara", "schema": { "type": "string" } }, { "name": "entidade", "in": "query", "required": false, "description": "nome do tomador: uma palavra acha pelo começo de qualquer palavra do nome (ex.: cli); com várias palavras, cada uma precisa ser palavra inteira do nome", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja (a chave precisa acessá-la; senão 403); sem loja_id e sem loja, só a loja da chave, não todas", "schema": { "type": "string" } }, { "name": "loja", "in": "query", "required": false, "description": "deixe vazio (loja=) para todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "contrato_id": { "type": "string" }, "pedido_id": { "type": "string" }, "codigo": { "type": "string" }, "rps": { "type": "string" }, "numero": { "type": "string" }, "codigo_verificacao": { "type": "string" }, "serie": { "type": "string" }, "data_emissao": { "type": "string" }, "data_emissao_ano": { "type": "string" }, "data_emissao_mes": { "type": "string" }, "hora_emissao": { "type": "string" }, "codigo_natureza_operacao": { "type": "string" }, "nome_natureza_operacao": { "type": "string" }, "codigo_incidencia_issqn": { "type": "string" }, "cidade_incidencia_issqn": { "type": "string" }, "emitente_cnpj": { "type": "string" }, "emitente_inscricao_municipal": { "type": "string" }, "destinatario_id_cliente": { "type": "string" }, "destinatario_nome_cliente": { "type": "string" }, "destinatario_tipo_pessoa": { "type": "string" }, "destinatario_razao_social": { "type": "string" }, "destinatario_cnpj": { "type": "string" }, "destinatario_cpf": { "type": "string" }, "destinatario_inscricao_municipal": { "type": "string" }, "destinatario_cep": { "type": "string" }, "destinatario_logradouro_endereco": { "type": "string" }, "destinatario_numero_endereco": { "type": "string" }, "destinatario_complemento_endereco": { "type": "string" }, "destinatario_bairro_endereco": { "type": "string" }, "destinatario_cidade_id_endereco": { "type": "string" }, "destinatario_nome_cidade_endereco": { "type": "string" }, "destinatario_codigo_cidade_endereco": { "type": "string" }, "dest_codigo_siafi": { "type": "string" }, "destinatario_estado_endereco": { "type": "string" }, "destinatario_telefone": { "type": "string" }, "destinatario_email": { "type": "string" }, "prestador_cep": { "type": "string" }, "prestador_logradouro": { "type": "string" }, "prestador_numero": { "type": "string" }, "prestador_complemento": { "type": "string" }, "prestador_bairro": { "type": "string" }, "prestador_cidade_id": { "type": "string" }, "prestador_nome_cidade": { "type": "string" }, "prestador_codigo_cidade": { "type": "string" }, "prestador_estado": { "type": "string" }, "descricao": { "type": "string" }, "atividade_id": { "type": "string" }, "codigo_atividade": { "type": "string" }, "atividade_descricao": { "type": "string" }, "atividade_codigo_tributacao": { "type": "string" }, "atividade_cnae": { "type": "string" }, "valor_servico": { "type": "string" }, "valor_base_calculo": { "type": "string" }, "valor_iss": { "type": "string" }, "iss_retido": { "type": "string" }, "valor_deducoes": { "type": "string" }, "valor_aliquota": { "type": "string" }, "descontos": { "type": "string" }, "construcao_civil": { "type": "string" }, "codigo_obra": { "type": "string" }, "codigo_art": { "type": "string" }, "indicador_operacao": { "type": "string" }, "codigo_indicador_operacao": { "type": "string" }, "tipo_operacao": { "type": "string" }, "aliquota_cofins": { "type": "string" }, "aliquota_pis": { "type": "string" }, "aliquota_csll": { "type": "string" }, "aliquota_ir": { "type": "string" }, "aliquota_inss": { "type": "string" }, "valor_cofins": { "type": "string" }, "valor_pis": { "type": "string" }, "valor_csll": { "type": "string" }, "valor_ir": { "type": "string" }, "valor_inss": { "type": "string" }, "cofins_retido": { "type": "string" }, "pis_retido": { "type": "string" }, "csll_retido": { "type": "string" }, "ir_retido": { "type": "string" }, "inss_retido": { "type": "string" }, "valor_total": { "type": "string" }, "outras_informacoes": { "type": "string" }, "situacao": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 15, "total_paginas": 1, "total_registros_pagina": 15, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "203", "empresa_id": "24", "loja_id": "65", "nome_loja": "Master", "contrato_id": "", "pedido_id": "", "codigo": "1", "rps": "0", "numero": "", "codigo_verificacao": "", "serie": "99", "data_emissao": "2025-05-15", "data_emissao_ano": "2025", "data_emissao_mes": "5", "hora_emissao": "16:59:00", "codigo_natureza_operacao": "1", "nome_natureza_operacao": "Tributação no município", "codigo_incidencia_issqn": "3106200", "cidade_incidencia_issqn": "Belo Horizonte (MG)", "emitente_cnpj": "", "emitente_inscricao_municipal": "", "destinatario_id_cliente": "58223", "destinatario_nome_cliente": "Cliente teste", "destinatario_tipo_pessoa": "PF", "destinatario_razao_social": "Cliente teste", "destinatario_cnpj": "", "destinatario_cpf": "526.867.180-48", "destinatario_inscricao_municipal": "", "destinatario_cep": "31110-000", "destinatario_logradouro_endereco": "Rua Célio de Castro", "destinatario_numero_endereco": "233", "destinatario_complemento_endereco": "", "destinatario_bairro_endereco": "Colégio Batista", "destinatario_cidade_id_endereco": "1411", "destinatario_nome_cidade_endereco": "Belo Horizonte", "destinatario_codigo_cidade_endereco": "3106200", "dest_codigo_siafi": "", "destinatario_estado_endereco": "MG", "destinatario_telefone": "", "destinatario_email": "sebastiao-darosa70@mushsanches.com", "prestador_cep": "", "prestador_logradouro": "", "prestador_numero": "", "prestador_complemento": "", "prestador_bairro": "", "prestador_cidade_id": "", "prestador_nome_cidade": "", "prestador_codigo_cidade": "", "prestador_estado": "", "descricao": "teste", "atividade_id": "22", "codigo_atividade": "1.07", "atividade_descricao": "sadasdsada", "atividade_codigo_tributacao": "0", "atividade_cnae": "6209100", "valor_servico": "1", "valor_base_calculo": "1", "valor_iss": "0.02", "iss_retido": "0", "valor_deducoes": "0", "valor_aliquota": "2", "descontos": "0", "construcao_civil": "0", "codigo_obra": "", "codigo_art": "", "indicador_operacao": "0", "codigo_indicador_operacao": "", "tipo_operacao": "", "aliquota_cofins": "1", "aliquota_pis": "4", "aliquota_csll": "6", "aliquota_ir": "7", "aliquota_inss": "8", "valor_cofins": "0.01", "valor_pis": "0.04", "valor_csll": "0.06", "valor_ir": "0.07", "valor_inss": "0.08", "cofins_retido": "1", "pis_retido": "1", "csll_retido": "1", "ir_retido": "1", "inss_retido": "1", "valor_total": "0.74", "outras_informacoes": "", "situacao": "Em aberto", "usuario_id": "130854", "nome_usuario": "Usuário", "cadastrado_em": "2025-05-15 16:59:57", "modificado_em": "2025-05-15 16:59:57" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de emissão da nota", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "NFS-e (nota de serviço); não se soma com NF-e nem NFC-e. Os códigos de situacao são diferentes dos da NF-e: 2 é Aprovada aqui. situacao vem por extenso na resposta: responda por ele. codigo é o número do RPS (é nele que o filtro rps procura); numero é o da prefeitura e vem vazio até a nota ser aprovada. Sem loja_id/loja, só entram as notas da loja da chave; e só as do ambiente (produção ou homologação) configurado na loja. Usuário sem a permissão de ver notas de outros usuários só enxerga as que ele emitiu. Atenção: na listagem os campos do tomador e do emitente às vezes vêm com o nome curto (dest_razao_social, dest_cnpj, emit_cnpj...) em vez de destinatario_*/emitente_* — leia os dois. Para total emitido no período use relatorio_nfse, já somado. A resposta não traz link do PDF nem do XML: para baixar, oriente a tela de NFS-e.", "description": "**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da nota. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Notas fiscais" ], "summary": "Cadastrar notas fiscais de serviços", "operationId": "fiscal_notas_fiscais_servicos_cadastrar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_servicos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal cadastrada com sucesso.", "dados": "223", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `destinatario_id_cliente`, `valor_servico`, `codigo_atividade`, `codigo_natureza_operacao`, `iss_retido`, `cidade_incidencia_issqn`, `estado_incidencia_issqn`, `descricao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loja_id": { "type": "string" }, "codigo_natureza_operacao": { "type": "integer" }, "cidade_incidencia_issqn": { "type": "string" }, "estado_incidencia_issqn": { "type": "string" }, "destinatario_id_cliente": { "type": "string" }, "descricao": { "type": "string" }, "codigo_atividade": { "type": "string" }, "iss_retido": { "type": "integer" }, "valor_servico": { "type": "string" }, "construcao_civil": { "type": "integer" }, "codigo_obra": { "type": "integer" }, "codigo_art": { "type": "integer" }, "indicador_operacao": { "type": "integer" }, "codigo_indicador_operacao": { "type": "string" }, "tipo_operacao": { "type": "integer" }, "envio_automatico": { "type": "integer" } } }, "example": { "loja_id": "65", "codigo_natureza_operacao": 1, "cidade_incidencia_issqn": "Belo Horizonte", "estado_incidencia_issqn": "MG", "destinatario_id_cliente": "58798", "descricao": "teste teste", "codigo_atividade": "1.05", "iss_retido": 0, "valor_servico": "2,00", "construcao_civil": 1, "codigo_obra": 1234, "codigo_art": 3212, "indicador_operacao": 1, "codigo_indicador_operacao": "100301", "tipo_operacao": 2, "envio_automatico": 1 } } } } } }, "/notas_fiscais_servicos/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Visualizar notas fiscais de serviços", "operationId": "fiscal_notas_fiscais_servicos_visualizar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_servicos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "contrato_id": { "type": "string" }, "pedido_id": { "type": "string" }, "codigo": { "type": "string" }, "rps": { "type": "string" }, "numero": { "type": "string" }, "codigo_verificacao": { "type": "string" }, "serie": { "type": "string" }, "data_emissao": { "type": "string" }, "data_emissao_ano": { "type": "string" }, "data_emissao_mes": { "type": "string" }, "hora_emissao": { "type": "string" }, "codigo_natureza_operacao": { "type": "string" }, "nome_natureza_operacao": { "type": "string" }, "codigo_incidencia_issqn": { "type": "string" }, "cidade_incidencia_issqn": { "type": "string" }, "emitente_cnpj": { "type": "string" }, "emitente_inscricao_municipal": { "type": "string" }, "destinatario_id_cliente": { "type": "string" }, "destinatario_nome_cliente": { "type": "string" }, "destinatario_tipo_pessoa": { "type": "string" }, "destinatario_razao_social": { "type": "string" }, "destinatario_cnpj": { "type": "string" }, "destinatario_cpf": { "type": "string" }, "destinatario_inscricao_municipal": { "type": "string" }, "destinatario_cep": { "type": "string" }, "destinatario_logradouro_endereco": { "type": "string" }, "destinatario_numero_endereco": { "type": "string" }, "destinatario_complemento_endereco": { "type": "string" }, "destinatario_bairro_endereco": { "type": "string" }, "destinatario_cidade_id_endereco": { "type": "string" }, "destinatario_nome_cidade_endereco": { "type": "string" }, "destinatario_codigo_cidade_endereco": { "type": "string" }, "dest_codigo_siafi": { "type": "string" }, "destinatario_estado_endereco": { "type": "string" }, "destinatario_telefone": { "type": "string" }, "destinatario_email": { "type": "string" }, "prestador_cep": { "type": "string" }, "prestador_logradouro": { "type": "string" }, "prestador_numero": { "type": "string" }, "prestador_complemento": { "type": "string" }, "prestador_bairro": { "type": "string" }, "prestador_cidade_id": { "type": "string" }, "prestador_nome_cidade": { "type": "string" }, "prestador_codigo_cidade": { "type": "string" }, "prestador_estado": { "type": "string" }, "descricao": { "type": "string" }, "atividade_id": { "type": "string" }, "codigo_atividade": { "type": "string" }, "atividade_descricao": { "type": "string" }, "atividade_codigo_tributacao": { "type": "string" }, "atividade_cnae": { "type": "string" }, "valor_servico": { "type": "string" }, "valor_base_calculo": { "type": "string" }, "valor_iss": { "type": "string" }, "iss_retido": { "type": "string" }, "valor_deducoes": { "type": "string" }, "valor_aliquota": { "type": "string" }, "descontos": { "type": "string" }, "construcao_civil": { "type": "string" }, "codigo_obra": { "type": "string" }, "codigo_art": { "type": "string" }, "indicador_operacao": { "type": "string" }, "codigo_indicador_operacao": { "type": "string" }, "tipo_operacao": { "type": "string" }, "aliquota_cofins": { "type": "string" }, "aliquota_pis": { "type": "string" }, "aliquota_csll": { "type": "string" }, "aliquota_ir": { "type": "string" }, "aliquota_inss": { "type": "string" }, "valor_cofins": { "type": "string" }, "valor_pis": { "type": "string" }, "valor_csll": { "type": "string" }, "valor_ir": { "type": "string" }, "valor_inss": { "type": "string" }, "cofins_retido": { "type": "string" }, "pis_retido": { "type": "string" }, "csll_retido": { "type": "string" }, "ir_retido": { "type": "string" }, "inss_retido": { "type": "string" }, "valor_total": { "type": "string" }, "outras_informacoes": { "type": "string" }, "situacao": { "type": "string" }, "hash": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "223", "empresa_id": "24", "loja_id": "65", "nome_loja": "Master", "contrato_id": "", "pedido_id": "", "codigo": "637852", "rps": "0", "numero": "", "codigo_verificacao": "", "serie": "1", "data_emissao": "2025-06-30", "data_emissao_ano": "2025", "data_emissao_mes": "6", "hora_emissao": "05:51:04", "codigo_natureza_operacao": "1", "nome_natureza_operacao": "Tributação no município", "codigo_incidencia_issqn": "3106200", "cidade_incidencia_issqn": "Belo Horizonte", "emitente_cnpj": "", "emitente_inscricao_municipal": "", "destinatario_id_cliente": "58798", "destinatario_nome_cliente": "SOLUCOES", "destinatario_tipo_pessoa": "PJ", "destinatario_razao_social": "SOLUCOES EM TECNOLOGIA LTDA", "destinatario_cnpj": "80.468.378/0001-53", "destinatario_cpf": "", "destinatario_inscricao_municipal": "", "destinatario_cep": "30110-915", "destinatario_logradouro_endereco": "AVENIDA DO CONTORNO", "destinatario_numero_endereco": "8", "destinatario_complemento_endereco": "SALA 8", "destinatario_bairro_endereco": "SANTA EFIGENIA", "destinatario_cidade_id_endereco": "1411", "destinatario_nome_cidade_endereco": "Belo Horizonte", "destinatario_codigo_cidade_endereco": "3106200", "dest_codigo_siafi": "", "destinatario_estado_endereco": "MG", "destinatario_telefone": "(31)0000-0000", "destinatario_email": "email@yahoo.com.br", "prestador_cep": "", "prestador_logradouro": "", "prestador_numero": "", "prestador_complemento": "", "prestador_bairro": "", "prestador_cidade_id": "", "prestador_nome_cidade": "", "prestador_codigo_cidade": "", "prestador_estado": "", "descricao": "teste teste", "atividade_id": "", "codigo_atividade": "1.05", "atividade_descricao": "Licenciamento ou cessão de direito de uso de programas de computação não customizáveis.", "atividade_codigo_tributacao": "10500188", "atividade_cnae": "620310000", "valor_servico": "2,00", "valor_base_calculo": "2.00", "valor_iss": "", "iss_retido": "0", "valor_deducoes": "0.00", "valor_aliquota": "2.0000", "descontos": "0.00", "construcao_civil": "1", "codigo_obra": "1234", "codigo_art": "3212", "indicador_operacao": "1", "codigo_indicador_operacao": "100301", "tipo_operacao": "2", "aliquota_cofins": "0.000", "aliquota_pis": "0.000", "aliquota_csll": "0.000", "aliquota_ir": "0.000", "aliquota_inss": "0.000", "valor_cofins": "0.00", "valor_pis": "0.00", "valor_csll": "0.00", "valor_ir": "0.00", "valor_inss": "0.00", "cofins_retido": "0", "pis_retido": "0", "csll_retido": "0", "ir_retido": "0", "inss_retido": "0", "valor_total": "2.00", "outras_informacoes": "", "situacao": "0", "hash": "mAB", "usuario_id": "45", "nome_usuario": "João da Silva", "cadastrado_em": "2025-06-30 17:51:04", "modificado_em": "2025-06-30 17:51:04" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Aqui situacao vem como CÓDIGO, não por extenso como na listagem: 0 = Em aberto, 1 = Enviando, 2 = Aprovada, 3 = Reprovada, 4 = Cancelada, 5 = Denegada. codigo é o número do RPS; numero é o da prefeitura (vazio até aprovar). Não traz link do PDF nem o XML: para baixar, oriente a tela de NFS-e.", "description": "404 quando a nota não existe, é de outra empresa ou de uma loja que o usuário da chave não acessa.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Notas fiscais" ], "summary": "Editar notas fiscais de serviços", "operationId": "fiscal_notas_fiscais_servicos_editar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_servicos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal atualizada com sucesso.", "dados": "216", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "**Campos obrigatórios:** `destinatario_id_cliente`, `valor_servico`, `codigo_atividade`, `codigo_natureza_operacao`, `iss_retido`, `cidade_incidencia_issqn`, `estado_incidencia_issqn`, `descricao`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "loja_id": { "type": "string" }, "codigo_natureza_operacao": { "type": "integer" }, "cidade_incidencia_issqn": { "type": "string" }, "estado_incidencia_issqn": { "type": "string" }, "destinatario_id_cliente": { "type": "string" }, "iss_retido": { "type": "integer" }, "descricao": { "type": "string" }, "codigo_atividade": { "type": "string" }, "valor_servico": { "type": "string" }, "construcao_civil": { "type": "integer" }, "codigo_obra": { "type": "integer" }, "codigo_art": { "type": "integer" }, "indicador_operacao": { "type": "integer" }, "codigo_indicador_operacao": { "type": "string" }, "tipo_operacao": { "type": "integer" } } }, "example": { "loja_id": "65", "codigo_natureza_operacao": 1, "cidade_incidencia_issqn": "Belo Horizonte", "estado_incidencia_issqn": "MG", "destinatario_id_cliente": "58798", "iss_retido": 0, "descricao": "teste teste", "codigo_atividade": "1.05", "valor_servico": "3,00", "construcao_civil": 1, "codigo_obra": 1234, "codigo_art": 3212, "indicador_operacao": 1, "codigo_indicador_operacao": "100301", "tipo_operacao": 2 } } } } }, "delete": { "tags": [ "Notas fiscais" ], "summary": "Deletar notas fiscais de serviços", "operationId": "fiscal_notas_fiscais_servicos_deletar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_servicos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "boolean" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota deletada com sucesso.", "dados": false, "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_servicos/emitir/{id}": { "post": { "tags": [ "Notas fiscais" ], "summary": "Emitir notas fiscais de serviços", "operationId": "fiscal_notas_fiscais_servicos_emitir", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_servicos", "x-operacao": "emitir", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal emitida com sucesso!", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "prefeitura" ], "description": "**Efeito fora do sistema:** transmite a nota à prefeitura. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_servicos/cancelar/{id}": { "post": { "tags": [ "Notas fiscais" ], "summary": "Cancelar notas fiscais de serviços", "operationId": "fiscal_notas_fiscais_servicos_cancelar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_servicos", "x-operacao": "cancelar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "ok": { "type": "boolean" }, "mensagem": { "type": "string" }, "dados": { "type": "string" }, "codigo": { "type": "integer" } } } } }, "example": { "code": 200, "status": "success", "data": { "ok": true, "mensagem": "Nota fiscal cancelada com sucesso.", "dados": "216", "codigo": 200 } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "prefeitura" ], "description": "**Efeito fora do sistema:** transmite a nota à prefeitura. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "motivo": { "type": "integer" } } }, "example": { "motivo": 1 } } } } } }, "/cfop": { "get": { "tags": [ "Notas fiscais" ], "summary": "Buscar CFOP", "operationId": "fiscal_cfop_listar", "x-modulo": "fiscal", "x-recurso": "cfop", "x-operacao": "listar", "parameters": [ { "name": "busca", "in": "query", "required": false, "description": "string — começo do código (ex.: 51 traz 5101, 5102…) ou parte da descrição (ex.: devolução); sem ele a tabela vem inteira, paginada", "schema": { "type": "string" } }, { "name": "referencia", "in": "query", "required": false, "description": "prod = CFOP de mercadorias (padrão), trans = CFOP de prestação de serviço de transporte", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "interestadual = só os CFOP de operação com outro estado (2xxx e 6xxx)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página, até 100 (padrão 20)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "filtros": { "type": "object", "properties": { "busca": { "type": "string" } } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "aplicacao": { "type": "string" }, "referencia": { "type": "string" }, "operacao": { "type": "string" }, "abrangencia": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "filtros": { "busca": "510" }, "total_registros": 7, "pagina": 1, "limite": 2, "total_paginas": 4 }, "data": { "itens": [ { "id": 288, "codigo": "5101", "descricao": "Venda de produção do estabelecimento", "aplicacao": "Venda de produto industrializado ou produzido pelo estabelecimento, bem como a de mercadoria por estabelecimento industrial ou produtor rural de cooperativa destinada a seus cooperados ou a estabelecimento de outra cooperativa.\n\n(NR Ajuste SINIEF 05/2005) (Dec.28.868/2006 - Efeitos a partir de 01/01/2006, ficando facultada ao contribuinte a sua adoção para fatos geradores ocorridos no período de 01 de novembro a 31 de dezembro de 2005)", "referencia": "prod", "operacao": "saida", "abrangencia": "estadual" }, { "id": 289, "codigo": "5102", "descricao": "Venda de mercadoria adquirida ou recebida de terceiros", "aplicacao": "Classificam-se neste código as vendas de mercadorias adquiridas ou recebidas de terceiros para industrialização ou comercialização, que não tenham sido objeto de qualquer processo industrial no estabelecimento. Também serão classificadas neste código as vendas de mercadorias por estabelecimento comercial de cooperativa destinadas a seus cooperados ou estabelecimento de outra cooperativa.", "referencia": "prod", "operacao": "saida", "abrangencia": "estadual" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NaturezasOperacoes/index", "x-ia": "O 1º dígito do CFOP diz o sentido e o alcance da operação: 1, 2 e 3 são ENTRADA (compra, devolução recebida, retorno) e 5, 6 e 7 são SAÍDA (venda, devolução enviada, remessa); 1 e 5 = dentro do estado, 2 e 6 = com outro estado, 3 e 7 = com o exterior. Isso já vem em operacao (entrada/saida) e abrangencia (estadual/interestadual/exterior). Um CFOP de entrada nunca vai numa nota de venda e vice-versa; a devolução usa o CFOP do sentido contrário ao da nota original (devolução de venda é entrada, 1202/2202; devolução de compra é saída, 5202/6202). O CFOP que a nota usa sai da natureza de operação (ou da regra fiscal do NCM/produto), não desta tabela: aqui é só consulta do código e do texto oficial (aplicacao). data.itens é uma página: o total está em meta.total_registros.", "description": "Tabela oficial de CFOP (Código Fiscal de Operações e Prestações), a mesma da busca do campo CFOP nas telas de natureza de operação, regras fiscais e nota fiscal. É uma tabela única para todas as empresas (não tem cadastro por empresa) e só de consulta.\n\n**Permissão exigida:** `Fiscal/NaturezasOperacoes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/intermediadores_transacoes": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar intermediadores de transação", "operationId": "fiscal_intermediadores_transacoes_listar", "x-modulo": "fiscal", "x-recurso": "intermediadores_transacoes", "x-operacao": "listar", "parameters": [ { "name": "busca", "in": "query", "required": false, "description": "string — parte do identificador (nome) do intermediador", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página, até 100 (padrão 20)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "identificador": { "type": "string" }, "cnpj": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "pagina": 1, "limite": 5, "total_paginas": 1 }, "data": { "itens": [ { "id": 121, "identificador": "Mercado Livre TESTE GCK-22721", "cnpj": "03.007.331/0001-41", "cadastrado_em": "2026-10-29 17:32:48", "modificado_em": "2026-10-29 17:32:48" }, { "id": 122, "identificador": "Shopee TESTE GCK-22721", "cnpj": "15.436.940/0001-03", "cadastrado_em": "2026-10-29 17:32:48", "modificado_em": "2026-10-29 17:32:48" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/IntermediadoresTransacoes/index", "x-ia": "Intermediador é o marketplace (Mercado Livre, Shopee, Amazon…) por onde a venda entrou; o identificador é o nome com que a empresa está cadastrada na plataforma e o CNPJ é o da plataforma. Ele só vai para a nota quando a operação é 'em site ou plataforma de terceiros' — venda direta não leva intermediador. data.itens é uma página: o total está em meta.total_registros.", "description": "Intermediadores de transação (marketplaces e plataformas de terceiros) cadastrados pela empresa (tela Fiscal > Intermediadores): o nome (identificador) e o CNPJ que vão no grupo de intermediador da NF-e/NFC-e quando a venda foi feita em site ou plataforma de terceiros. Só leitura — cadastrar, editar e excluir não estão na API.\n\nO cadastro é da empresa: vale para todas as lojas, e loja_id não filtra.\n\n**Permissão exigida:** `Fiscal/IntermediadoresTransacoes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/intermediadores_transacoes/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Visualizar intermediadores de transação", "operationId": "fiscal_intermediadores_transacoes_visualizar", "x-modulo": "fiscal", "x-recurso": "intermediadores_transacoes", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "identificador": { "type": "string" }, "cnpj": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": 121, "identificador": "Mercado Livre TESTE GCK-22721", "cnpj": "03.007.331/0001-41", "cadastrado_em": "2026-10-29 17:32:48", "modificado_em": "2026-10-29 17:32:48" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/IntermediadoresTransacoes/visualizar", "description": "**Permissão exigida:** `Fiscal/IntermediadoresTransacoes/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/naturezas_operacoes": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar naturezas de operação", "operationId": "fiscal_naturezas_operacoes_listar", "x-modulo": "fiscal", "x-recurso": "naturezas_operacoes", "x-operacao": "listar", "parameters": [ { "name": "busca", "in": "query", "required": false, "description": "string — parte do nome ou do CFOP (estadual) da natureza", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram as naturezas liberadas em qualquer loja que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página, até 100 (padrão 20)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "regra": { "type": "string" }, "nome_regra": { "type": "string" }, "tipo": { "type": "integer" }, "nome_tipo": { "type": "string" }, "finalidade": { "type": "integer" }, "nome_finalidade": { "type": "string" }, "consumidor_final": { "type": "boolean" }, "presenca": { "type": "integer" }, "nome_presenca": { "type": "string" }, "destino": { "type": "integer" }, "nome_destino": { "type": "string" }, "grupo_tributacao_id": { "type": "integer" }, "nome_grupo_tributacao": { "type": "string" }, "codigo_cfop": { "type": "string" }, "descricao_cfop": { "type": "string" }, "codigo_cfop_interestadual": { "type": "string" }, "descricao_cfop_interestadual": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 5, "total_paginas": 1 }, "data": { "itens": [ { "id": 440568, "nome": "Venda", "regra": "ven", "nome_regra": "Venda", "tipo": 1, "nome_tipo": "Saída", "finalidade": 1, "nome_finalidade": "NF-e normal", "consumidor_final": true, "presenca": 0, "nome_presenca": "Não se aplica", "destino": 1, "nome_destino": "Operação interna", "grupo_tributacao_id": 4931, "nome_grupo_tributacao": "Simples", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "codigo_cfop_interestadual": "6102", "descricao_cfop_interestadual": "Venda de mercadoria adquirida ou recebida de terceiros", "cadastrado_em": "2026-09-25 13:36:48", "modificado_em": "2026-09-25 13:36:48" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NaturezasOperacoes/index", "x-ia": "A natureza de operação é o modelo da nota: tipo 0 = entrada, 1 = saída; o CFOP que vai no item é codigo_cfop quando o destinatário é do mesmo estado da loja e codigo_cfop_interestadual quando é de outro estado. A tributação (ICMS, IPI, PIS, COFINS) vem do grupo de tributação (nome_grupo_tributacao), mas é só o último recurso: tributação do produto, regra fiscal do NCM (GET /ncm/{codigo}) e grupo do produto passam na frente. regra (ven, vnc, vco, cup, com…) diz para que a natureza é sugerida por padrão (venda, venda a contribuinte, cupom fiscal/NFC-e, compra). Os códigos vêm com o nome ao lado (nome_tipo, nome_regra, nome_finalidade, nome_presenca, nome_destino): responda pelo nome. codigo_cfop_interestadual pode vir null, e há natureza cujo codigo_cfop já é de outro estado (ex.: 6102): para dizer se a operação é dentro ou fora do estado, olhe o 1º dígito do CFOP (5 ou 1 = dentro, 6 ou 2 = fora). Cada natureza só aparece nas lojas em que está liberada. data.itens é uma página: o total está em meta.total_registros.", "description": "Naturezas de operação de NF-e e NFC-e cadastradas pela empresa (tela Fiscal > Naturezas de operação): o tipo de nota (entrada ou saída), a finalidade, o CFOP estadual e interestadual e o grupo de tributação que a nota usa. Só leitura — cadastrar, editar e excluir não estão na API. As naturezas de NFS-e estão em /naturezas_operacoes_servicos.\n\n**Permissão exigida:** `Fiscal/NaturezasOperacoes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/naturezas_operacoes/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Visualizar naturezas de operação", "operationId": "fiscal_naturezas_operacoes_visualizar", "x-modulo": "fiscal", "x-recurso": "naturezas_operacoes", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "regra": { "type": "string" }, "nome_regra": { "type": "string" }, "tipo": { "type": "integer" }, "nome_tipo": { "type": "string" }, "finalidade": { "type": "integer" }, "nome_finalidade": { "type": "string" }, "consumidor_final": { "type": "boolean" }, "presenca": { "type": "integer" }, "nome_presenca": { "type": "string" }, "destino": { "type": "integer" }, "nome_destino": { "type": "string" }, "grupo_tributacao_id": { "type": "integer" }, "nome_grupo_tributacao": { "type": "string" }, "codigo_cfop": { "type": "string" }, "descricao_cfop": { "type": "string" }, "codigo_cfop_interestadual": { "type": "string" }, "descricao_cfop_interestadual": { "type": "string" }, "informacoes_complementares": { "type": [ "string", "null" ] }, "informacoes_fisco": { "type": [ "string", "null" ] }, "lojas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" } } } }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": 440568, "nome": "Venda", "regra": "ven", "nome_regra": "Venda", "tipo": 1, "nome_tipo": "Saída", "finalidade": 1, "nome_finalidade": "NF-e normal", "consumidor_final": true, "presenca": 0, "nome_presenca": "Não se aplica", "destino": 1, "nome_destino": "Operação interna", "grupo_tributacao_id": 4931, "nome_grupo_tributacao": "Simples", "codigo_cfop": "5102", "descricao_cfop": "Venda de mercadoria adquirida ou recebida de terceiros", "codigo_cfop_interestadual": "6102", "descricao_cfop_interestadual": "Venda de mercadoria adquirida ou recebida de terceiros", "informacoes_complementares": null, "informacoes_fisco": null, "lojas": [ { "id": 65, "nome": "Master" }, { "id": 80154, "nome": "Teste Financeiro Pa" }, { "id": 80542, "nome": "ads test" }, { "id": 80764, "nome": "11" }, { "id": 80773, "nome": "Conta Integrada" } ], "cadastrado_em": "2026-09-25 13:36:48", "modificado_em": "2026-09-25 13:36:48" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NaturezasOperacoes/visualizar", "description": "Inclui as informações complementares e ao fisco que a natureza põe na nota e as lojas em que ela está liberada.\n\n**Permissão exigida:** `Fiscal/NaturezasOperacoes/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ncm": { "get": { "tags": [ "Notas fiscais" ], "summary": "Buscar NCM", "operationId": "fiscal_ncm_listar", "x-modulo": "fiscal", "x-recurso": "ncm", "x-operacao": "listar", "parameters": [ { "name": "busca", "in": "query", "required": false, "description": "string, obrigatório (mínimo 2 caracteres) — começo do código, com ou sem pontos (ex.: 8471 ou 8471.30), ou parte da descrição oficial (ex.: camisa, cerveja), sem diferença de acento", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — loja cujo estado define as alíquotas estaduais (meta.estado_aliquotas); sem ele, a loja da chave", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página, até 100 (padrão 20)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "filtros": { "type": "object", "properties": { "busca": { "type": "string" } } }, "estado_aliquotas": { "type": "string" }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "cest": { "type": [ "string", "null" ] }, "aliquotas_aproximadas": { "type": "object", "properties": { "federal_nacional": { "type": "number" }, "federal_importado": { "type": "number" }, "estadual": { "type": "integer" }, "municipal": { "type": "integer" }, "vigencia": { "type": [ "string", "null" ] } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "filtros": { "busca": "8471.30" }, "estado_aliquotas": "MG", "total_registros": 4, "pagina": 1, "limite": 2, "total_paginas": 2 }, "data": { "itens": [ { "id": 12803, "codigo": "84713011", "descricao": "De peso inferior a 350 g, com teclado alfanumérico de no mínimo 70 teclas e com uma tela de área não superior a 140 cm2", "cest": null, "aliquotas_aproximadas": { "federal_nacional": 13.980000000000000426325641456060111522674560546875, "federal_importado": 14.5800000000000000710542735760100185871124267578125, "estadual": 12, "municipal": 0, "vigencia": null } }, { "id": 12804, "codigo": "84713012", "descricao": "De peso inferior a 3,5 kg com teclado alfanumérico de no mínimo 70 teclas e com uma tela de área superior a 140 cm2 e inferior a 560 cm2", "cest": null, "aliquotas_aproximadas": { "federal_nacional": 13.980000000000000426325641456060111522674560546875, "federal_importado": 24.9200000000000017053025658242404460906982421875, "estadual": 12, "municipal": 0, "vigencia": null } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/Tributacoes/index", "x-ia": "A descrição é o texto oficial da tabela, curto e abreviado (computador portátil aparece como \"Maqs.dig.proc.dados,bater/eletr.portat...\"): nome popular como notebook ou refrigerante costuma voltar vazio. Se a busca por nome vier vazia, tente outra palavra do texto oficial ou o começo do código antes de dizer que o NCM não existe. Só vêm NCMs de 8 dígitos (o nível que vai na nota e no cadastro do produto). aliquotas_aproximadas são os percentuais do IBPT usados para mostrar o valor aproximado de tributos na nota (Lei 12.741/2012): são REFERÊNCIA e não são as alíquotas de ICMS, IPI, PIS ou COFINS que a nota calcula — essas saem da regra fiscal (natureza de operação, grupo de tributação, regra do NCM ou do produto). A busca descreve o código, não diz se o NCM serve para um produto: o enquadramento é responsabilidade do contador. Para as regras fiscais que a empresa cadastrou para um NCM use GET /ncm/{codigo}. data.itens é uma página: o total está em meta.total_registros.", "description": "Tabela de NCM (Nomenclatura Comum do Mercosul) com as alíquotas aproximadas de tributos (IBPT) e, no detalhe, as regras fiscais que a empresa cadastrou para o NCM (tela Fiscal > NCM). A tabela de NCM é a da Receita, única para todas as empresas; NCMs cadastrados por uma empresa só aparecem para ela. As regras fiscais por NCM são da empresa. Só consulta.\n\n**Permissão exigida:** `Fiscal/Tributacoes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/ncm/{codigo}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Visualizar NCM", "operationId": "fiscal_ncm_visualizar", "x-modulo": "fiscal", "x-recurso": "ncm", "x-operacao": "visualizar", "parameters": [ { "name": "codigo", "in": "path", "required": true, "description": "Código do NCM com 8 dígitos, sem pontos (ex.: 84713012)", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "codigo": { "type": "string" }, "descricao": { "type": "string" }, "cest": { "type": [ "string", "null" ] }, "aliquotas_aproximadas": { "type": "object", "properties": { "federal_nacional": { "type": "number" }, "federal_importado": { "type": "number" }, "estadual": { "type": "integer" }, "municipal": { "type": "integer" }, "vigencia": { "type": [ "string", "null" ] } } }, "segmentar_tributacao": { "type": "boolean" }, "regras_fiscais": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "natureza_operacao_id": { "type": "integer" }, "nome_natureza_operacao": { "type": "string" }, "grupo_tributacao_id": { "type": "integer" }, "nome_grupo_tributacao": { "type": "string" }, "codigo_cfop": { "type": "string" }, "descricao_cfop": { "type": "string" }, "codigo_cfop_interestadual": { "type": "string" }, "descricao_cfop_interestadual": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": 12804, "codigo": "84713012", "descricao": "De peso inferior a 3,5 kg com teclado alfanumérico de no mínimo 70 teclas e com uma tela de área superior a 140 cm2 e inferior a 560 cm2", "cest": null, "aliquotas_aproximadas": { "federal_nacional": 13.980000000000000426325641456060111522674560546875, "federal_importado": 24.9200000000000017053025658242404460906982421875, "estadual": 12, "municipal": 0, "vigencia": null }, "segmentar_tributacao": true, "regras_fiscais": [ { "id": 27, "natureza_operacao_id": 440568, "nome_natureza_operacao": "Venda", "grupo_tributacao_id": 4931, "nome_grupo_tributacao": "Simples", "codigo_cfop": "5405", "descricao_cfop": "Venda de mercadoria, adquirida ou recebida de terceiros, sujeita ao regime de substituição tributária, na condição de contribuinte-substituído", "codigo_cfop_interestadual": "6404", "descricao_cfop_interestadual": "Venda de mercadoria sujeita ao regime de substituição tributária, cujo imposto já tenha sido retido anteriormente", "cadastrado_em": "2026-10-27 19:03:36", "modificado_em": "2026-10-27 19:03:36" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/Tributacoes/visualizar", "x-ia": "regras_fiscais é a exceção que a empresa cadastrou para o NCM: cada regra aponta um grupo de tributação e, opcionalmente, a natureza de operação a que se aplica e os CFOP estadual/interestadual. Na emissão de NF-e/NFC-e a tributação de cada item é escolhida nesta ordem de prioridade: a tributação cadastrada no próprio produto, depois a regra do NCM (a da mesma natureza da nota; sem ela, a regra sem natureza), depois a do grupo do produto; a tributação da natureza de operação só vale quando nenhuma dessas existe, e o CFOP da natureza só entra quando a regra escolhida não tem CFOP. Ou seja: uma regra de NCM passa na frente da natureza de operação. segmentar_tributacao = true quando há regra por natureza ou mais de uma regra. As aliquotas_aproximadas (IBPT) são só referência para o valor aproximado de tributos e não entram no cálculo do imposto.", "description": "Aceita também o código com 7 dígitos (o zero da frente perdido vira 0 de novo: 1012100 = 01012100). Devolve o NCM com as alíquotas aproximadas e as regras fiscais da empresa para ele (regras_fiscais, vazia quando a empresa não cadastrou nenhuma). 404 quando o código não existe na tabela e a empresa não tem regra para ele.\n\n**Permissão exigida:** `Fiscal/Tributacoes/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_compras": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar notas fiscais de entrada", "operationId": "fiscal_notas_fiscais_compras_listar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_compras", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão da nota); DD/MM/AAAA dá 400", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "fornecedor", "in": "query", "required": false, "description": "string — nome do emitente/fornecedor como veio na nota (busca parcial)", "schema": { "type": "string" } }, { "name": "chave", "in": "query", "required": false, "description": "string — chave de acesso de 44 dígitos (exata); sem data_inicio/data_fim procura em qualquer data", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "nfe = NF-e de produtos, nfse = NFS-e importada; sem ele entram as duas", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "manifestação do destinatário: 0 = Não informada (ainda não manifestada), 1 = Confirmada, 2 = Recusada, 3 = Informada", "schema": { "type": "string" } }, { "name": "situacao_xml", "in": "query", "required": false, "description": "1 = XML completo já está no sistema, 2 = manifestada e aguardando a SEFAZ liberar o XML", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" } } }, "data": { "type": "object", "properties": { "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "tipo": { "type": "string" }, "chave": { "type": "string" }, "numero_nfse": { "type": "string" }, "codigo_verificacao": { "type": "string" }, "municipio_codigo_ibge": { "type": "string" }, "data_emissao": { "type": "string" }, "fornecedor": { "type": "string" }, "valor_total": { "type": "integer" }, "situacao": { "type": "string" }, "nome_situacao": { "type": "string" }, "situacao_xml": { "type": "string" }, "xml_disponivel": { "type": "boolean" }, "manifestada_em": { "type": "string" }, "compra_id": { "type": "string" }, "codigo_compra": { "type": [ "string", "null" ] }, "usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de emissão da nota", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 2, "total_paginas": 1 }, "data": { "itens": [ { "id": "2067", "loja_id": "65", "nome_loja": "Loja Teste", "tipo": "nfe", "chave": "31261011222333000181550010000090021000090020", "numero_nfse": "", "codigo_verificacao": "", "municipio_codigo_ibge": "", "data_emissao": "2026-10-14", "fornecedor": "Outro Fornecedor API TESTE GCK-22568", "valor_total": 420, "situacao": "0", "nome_situacao": "Não informada", "situacao_xml": "2", "xml_disponivel": false, "manifestada_em": "", "compra_id": "", "codigo_compra": null, "usuario": "Usuário Teste", "cadastrado_em": "2026-10-27 18:01:15", "modificado_em": "2026-10-27 18:01:15" }, { "id": "2066", "loja_id": "65", "nome_loja": "Loja Teste", "tipo": "nfe", "chave": "31261011222333000181550010000090011000090010", "numero_nfse": "", "codigo_verificacao": "", "municipio_codigo_ibge": "", "data_emissao": "2026-10-06", "fornecedor": "Fornecedor API TESTE GCK-22568", "valor_total": 1530.75, "situacao": "1", "nome_situacao": "Confirmada", "situacao_xml": "1", "xml_disponivel": true, "manifestada_em": "", "compra_id": "", "codigo_compra": null, "usuario": "Usuário Teste", "cadastrado_em": "2026-10-27 18:01:15", "modificado_em": "2026-10-27 18:01:15" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NotasFiscaisCompras/index", "x-periodo": { "data": "a data de emissão da nota", "padrao": "mês atual (com chave e sem data_inicio/data_fim, qualquer data)", "teto_meses": 12 }, "x-ia": "Nota de entrada é a nota que um FORNECEDOR emitiu para a empresa (compra) — não é nota emitida pela empresa (essas estão em /relatorios/nfe, /nfce, /nfse) nem a compra lançada no módulo de Compras (o vínculo vem em compra_id/codigo_compra quando a compra foi gerada a partir da nota). data.itens é uma página: o número de notas é meta.total_registros; para valor total some só se tiver todas as páginas. situacao é a manifestação do destinatário, não a situação da nota na SEFAZ; nome_situacao traz o nome por extenso (Não informada, Confirmada, Recusada, Informada): responda por ele. xml_disponivel = false quer dizer que o XML completo ainda não está no sistema (só o resumo da nota). Para achar uma nota pela chave de acesso use o filtro chave (procura em qualquer data).", "description": "Notas fiscais de compra (entrada) recebidas pela empresa: as NF-e emitidas contra o CNPJ da loja que chegam pela SEFAZ (manifestação do destinatário) e os XMLs de NF-e e NFS-e importados. Só leitura — é a mesma lista da tela Fiscal > Notas de entrada. Importar XML, baixar XML, DANFE e excluir não estão na API.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da nota. Sem elas: mês atual (com chave e sem data_inicio/data_fim, qualquer data). Máximo: 12 meses.\n\n**Permissão exigida:** `Fiscal/NotasFiscaisCompras/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/notas_fiscais_compras/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Visualizar notas fiscais de entrada", "operationId": "fiscal_notas_fiscais_compras_visualizar", "x-modulo": "fiscal", "x-recurso": "notas_fiscais_compras", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "tipo": { "type": "string" }, "chave": { "type": "string" }, "numero_nfse": { "type": "string" }, "codigo_verificacao": { "type": "string" }, "municipio_codigo_ibge": { "type": "string" }, "data_emissao": { "type": "string" }, "fornecedor": { "type": "string" }, "valor_total": { "type": "integer" }, "situacao": { "type": "string" }, "nome_situacao": { "type": "string" }, "situacao_xml": { "type": "string" }, "xml_disponivel": { "type": "boolean" }, "manifestada_em": { "type": "string" }, "compra_id": { "type": "string" }, "codigo_compra": { "type": [ "string", "null" ] }, "usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "2067", "loja_id": "65", "nome_loja": "Loja Teste", "tipo": "nfe", "chave": "31261011222333000181550010000090021000090020", "numero_nfse": "", "codigo_verificacao": "", "municipio_codigo_ibge": "", "data_emissao": "2026-10-14", "fornecedor": "Outro Fornecedor API TESTE GCK-22568", "valor_total": 420, "situacao": "0", "nome_situacao": "Não informada", "situacao_xml": "2", "xml_disponivel": false, "manifestada_em": "", "compra_id": "", "codigo_compra": null, "usuario": "Usuário Teste", "cadastrado_em": "2026-10-27 18:01:15", "modificado_em": "2026-10-27 18:01:15" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NotasFiscaisCompras/index", "description": "Devolve a nota em qualquer data, desde que seja de uma loja que o usuário da chave acessa e não tenha sido excluída. Os itens da nota não vêm: eles ficam no XML, que a API não entrega.\n\n**Permissão exigida:** `Fiscal/NotasFiscaisCompras/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/nfce": { "get": { "tags": [ "Notas fiscais" ], "summary": "Consultar relatório de NFC-e", "operationId": "fiscal_relatorio_nfce_listar", "x-modulo": "fiscal", "x-recurso": "relatorio_nfce", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "uma situação: 0 = Em aberto, 1 = Aprovada, 2 = Reprovada, 3 = Denegada, 4 = Cancelada, 5 = Enviando, 6 = Corrigida; sem ela entram todas", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "int — número da NFC-e (dentro do período)", "schema": { "type": "string" } }, { "name": "documento", "in": "query", "required": false, "description": "string — CPF ou CNPJ do consumidor (com ou sem pontuação)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" }, "icms": { "type": "number" }, "ipi": { "type": "integer" }, "pis": { "type": "number" }, "cofins": { "type": "number" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "numero": { "type": "string" }, "data_emissao": { "type": "string" }, "tipo": { "type": "string" }, "cfop": { "type": "string" }, "natureza_operacao": { "type": "string" }, "destinatario": { "type": "string" }, "destinatario_documento": { "type": "string" }, "situacao_nome": { "type": "string" }, "loja": { "type": "string" }, "valor_icms": { "type": "number" }, "valor_ipi": { "type": "integer" }, "valor_pis": { "type": "number" }, "valor_cofins": { "type": "number" }, "valor_total": { "type": "integer" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de emissão da NFC-e", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 1, "valor_total": 120, "icms": 21.60000000000000142108547152020037174224853515625, "ipi": 0, "pis": 1.979999999999999982236431605997495353221893310546875, "cofins": 9.1199999999999992184029906638897955417633056640625 }, "itens": [ { "id": "1500", "numero": "7001", "data_emissao": "2026-10-20", "tipo": "Saída", "cfop": "5102", "natureza_operacao": "Venda ao consumidor", "destinatario": "Consumidor API TESTE GCK-22568", "destinatario_documento": "", "situacao_nome": "Aprovada", "loja": "Loja Teste", "valor_icms": 21.60000000000000142108547152020037174224853515625, "valor_ipi": 0, "valor_pis": 1.979999999999999982236431605997495353221893310546875, "valor_cofins": 9.1199999999999992184029906638897955417633056640625, "valor_total": 120, "cadastrado_em": "2026-10-27 18:01:15" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NotasFiscaisConsumidores/gerar_relatorios", "x-periodo": { "data": "a data de emissão da NFC-e", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais (quantidade, valor_total e os impostos): responda quantidade e valor juntos e cite o período de meta.periodo. data.itens é só uma página — nunca some as linhas. situacao aceita um valor só (lista, como situacao[]=, não funciona): para somar duas situações, faça uma chamada para cada. SEM o filtro situacao os totais incluem notas canceladas, reprovadas e em aberto (a tela abre com Aprovada marcada): para o faturamento em cupom use situacao=1 e diga isso. Nas linhas a situação vem só pelo nome (situacao_nome). NFC-e é a nota do varejo ao consumidor; NF-e está em /relatorios/nfe e NFS-e em /relatorios/nfse. Usuário sem a permissão de ver notas de outros usuários só enxerga as que ele emitiu.", "description": "NFC-e (modelo 65, cupom fiscal eletrônico) emitidas no período, com os totais de valor, ICMS, IPI, PIS e COFINS já somados e a lista das notas. É a mesma regra do relatório de NFC-e da tela Fiscal > Relatórios. Só o ambiente configurado de cada loja (produção ou homologação) entra.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da NFC-e. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Fiscal/NotasFiscaisConsumidores/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/nfe": { "get": { "tags": [ "Notas fiscais" ], "summary": "Consultar relatório de NF-e", "operationId": "fiscal_relatorio_nfe_listar", "x-modulo": "fiscal", "x-recurso": "relatorio_nfe", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "0 = Entrada, 1 = Saída; sem ele entram as duas", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "uma situação: 0 = Em aberto, 1 = Aprovada, 2 = Reprovada, 3 = Denegada, 4 = Cancelada, 5 = Enviando, 6 = Corrigida; sem ela entram todas", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "int — número da NF-e (dentro do período)", "schema": { "type": "string" } }, { "name": "natureza_operacao_id", "in": "query", "required": false, "description": "int — id da natureza de operação (cadastro Fiscal > Naturezas de operação)", "schema": { "type": "string" } }, { "name": "documento", "in": "query", "required": false, "description": "string — CPF ou CNPJ do destinatário (com ou sem pontuação)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valor_total": { "type": "number" }, "icms": { "type": "integer" }, "ipi": { "type": "integer" }, "pis": { "type": "number" }, "cofins": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "numero": { "type": "string" }, "data_emissao": { "type": "string" }, "tipo": { "type": "string" }, "cfop": { "type": "string" }, "natureza_operacao": { "type": "string" }, "destinatario": { "type": "string" }, "destinatario_documento": { "type": "string" }, "situacao": { "type": "string" }, "situacao_nome": { "type": "string" }, "loja": { "type": "string" }, "valor_icms": { "type": "integer" }, "valor_ipi": { "type": "integer" }, "valor_pis": { "type": "integer" }, "valor_cofins": { "type": "integer" }, "valor_total": { "type": "integer" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de emissão da NF-e", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 3, "pagina": 1, "limite": 2, "total_paginas": 2, "cache": false }, "data": { "totais": { "quantidade": 3, "valor_total": 1330.5, "icms": 225, "ipi": 10, "pis": 20.629999999999999005240169935859739780426025390625, "cofins": 95 }, "itens": [ { "id": "1499", "numero": "9003", "data_emissao": "2026-10-15", "tipo": "Entrada", "cfop": "5202", "natureza_operacao": "Devolução de compra", "destinatario": "Fornecedor API TESTE GCK-22568", "destinatario_documento": "44.555.666/0001-02", "situacao": "4", "situacao_nome": "Cancelada", "loja": "Loja Teste", "valor_icms": 0, "valor_ipi": 0, "valor_pis": 0, "valor_cofins": 0, "valor_total": 80, "cadastrado_em": "2026-10-27 18:01:15" }, { "id": "1498", "numero": "9002", "data_emissao": "2026-10-12", "tipo": "Saída", "cfop": "5102", "natureza_operacao": "Venda de mercadoria", "destinatario": "Cliente API TESTE GCK-22568", "destinatario_documento": "11.222.333/0001-81", "situacao": "1", "situacao_nome": "Aprovada", "loja": "Loja Teste", "valor_icms": 45, "valor_ipi": 10, "valor_pis": 4.12999999999999989341858963598497211933135986328125, "valor_cofins": 19, "valor_total": 250.5, "cadastrado_em": "2026-10-27 18:01:15" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NotasFiscais/gerar_relatorios", "x-periodo": { "data": "a data de emissão da NF-e", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais (quantidade, valor_total e os impostos): responda quantidade e valor juntos e cite o período de meta.periodo. data.itens é só uma página — nunca some as linhas. situacao aceita um valor só (lista, como situacao[]=, não funciona): para somar duas situações, faça uma chamada para cada. SEM o filtro situacao os totais incluem notas canceladas, reprovadas e em aberto (a tela abre com Aprovada marcada): para faturamento emitido use situacao=1 e diga isso na resposta. Sem tipo, mistura notas de saída (venda) e de entrada emitidas pela própria empresa (devolução, entrada de produtor); para vendas use tipo=1. Nota de fornecedor (compra) não está aqui: é /notas_fiscais_compras. Usuário sem a permissão de ver notas de outros usuários só enxerga as que ele emitiu.", "description": "NF-e (modelo 55) emitidas pela empresa no período, com os totais de valor, ICMS, IPI, PIS e COFINS já somados e a lista das notas. É a mesma regra do relatório de NF-e da tela Fiscal > Relatórios. Só o ambiente configurado de cada loja (produção ou homologação) entra.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da NF-e. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Fiscal/NotasFiscais/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/nfse": { "get": { "tags": [ "Notas fiscais" ], "summary": "Consultar relatório de NFS-e", "operationId": "fiscal_relatorio_nfse_listar", "x-modulo": "fiscal", "x-recurso": "relatorio_nfse", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "uma situação: 0 = Em aberto, 1 = Enviando, 2 = Aprovada, 3 = Reprovada, 4 = Cancelada, 5 = Denegada; sem ela entram todas", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" }, "inss": { "type": "integer" }, "csll": { "type": "integer" }, "ir": { "type": "integer" }, "pis": { "type": "number" }, "cofins": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "numero": { "type": "string" }, "codigo_rps": { "type": "string" }, "data_emissao": { "type": "string" }, "ambiente": { "type": "string" }, "natureza_operacao": { "type": "string" }, "natureza_operacao_nome": { "type": "string" }, "tomador": { "type": "string" }, "tomador_documento": { "type": "string" }, "situacao": { "type": "string" }, "situacao_nome": { "type": "string" }, "motivo": { "type": "string" }, "loja": { "type": "string" }, "valor_inss": { "type": "integer" }, "valor_csll": { "type": "integer" }, "valor_ir": { "type": "integer" }, "valor_pis": { "type": "integer" }, "valor_cofins": { "type": "integer" }, "valor_total": { "type": "integer" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de emissão da NFS-e", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 2, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 2, "valor_total": 1300, "inss": 0, "csll": 10, "ir": 15, "pis": 6.5, "cofins": 30 }, "itens": [ { "id": "990003", "numero": "502", "codigo_rps": "0", "data_emissao": "2026-10-18", "ambiente": "2", "natureza_operacao": "1", "natureza_operacao_nome": "Tributação no município", "tomador": "Tomador API TESTE GCK-22568", "tomador_documento": "11.222.333/0001-81", "situacao": "4", "situacao_nome": "Cancelada", "motivo": "", "loja": "Loja Teste", "valor_inss": 0, "valor_csll": 0, "valor_ir": 0, "valor_pis": 0, "valor_cofins": 0, "valor_total": 300, "cadastrado_em": "2026-10-27 18:01:15" }, { "id": "990002", "numero": "501", "codigo_rps": "0", "data_emissao": "2026-10-08", "ambiente": "2", "natureza_operacao": "1", "natureza_operacao_nome": "Tributação no município", "tomador": "Tomador API TESTE GCK-22568", "tomador_documento": "11.222.333/0001-81", "situacao": "2", "situacao_nome": "Aprovada", "motivo": "", "loja": "Loja Teste", "valor_inss": 0, "valor_csll": 10, "valor_ir": 15, "valor_pis": 6.5, "valor_cofins": 30, "valor_total": 1000, "cadastrado_em": "2026-10-27 18:01:15" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Fiscal/NotasFiscaisServicos/gerar_relatorios", "x-periodo": { "data": "a data de emissão da NFS-e", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Os totais já vêm somados em data.totais (quantidade, valor_total e as retenções federais): responda quantidade e valor juntos e cite o período de meta.periodo. data.itens é só uma página — nunca some as linhas. situacao aceita um valor só (lista, como situacao[]=, não funciona): para somar duas situações, faça uma chamada para cada. SEM o filtro situacao os totais incluem notas canceladas, reprovadas e em aberto (a tela abre com Aprovada marcada): para serviço faturado use situacao=2 — ATENÇÃO, na NFS-e Aprovada é 2 (na NF-e/NFC-e é 1). O ISS não vem neste relatório. numero é o número da prefeitura e codigo_rps o número do RPS. Usuário sem a permissão de ver notas de outros usuários só enxerga as que ele emitiu.", "description": "NFS-e (nota de serviço) emitidas no período, com os totais de valor, INSS, CSLL, IR, PIS e COFINS já somados e a lista das notas. É a mesma regra do relatório de NFS-e da tela Fiscal > Relatórios. Só o ambiente configurado de cada loja (produção ou homologação) entra.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão da NFS-e. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Fiscal/NotasFiscaisServicos/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/mdfe": { "get": { "tags": [ "MDF-e" ], "summary": "Listar manifestos (MDF-e)", "operationId": "mdfe_mdfe_listar", "x-modulo": "mdfe", "x-recurso": "mdfe", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de emissão do manifesto)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "ambiente", "in": "query", "required": false, "description": "1 = produção (padrão), 2 = homologação. Manifesto emitido em homologação não tem valor fiscal", "schema": { "type": "string" } }, { "name": "numero", "in": "query", "required": false, "description": "string — número do MDF-e (não é o id); com ele o período é ignorado", "schema": { "type": "string" } }, { "name": "serie", "in": "query", "required": false, "description": "string — série do MDF-e", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "situações do manifesto: 0 = Em aberto, 1 = Aprovada (autorizado pela SEFAZ), 2 = Reprovada, 3 = Encerrado, 4 = Cancelado; sem ela entram todas — aceita vários: `situacao=1,2` ou `situacao[]=1&situacao[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "placa", "in": "query", "required": false, "description": "string — placa do veículo de tração (com ou sem hífen; filtro exato)", "schema": { "type": "string" } }, { "name": "condutor", "in": "query", "required": false, "description": "string — nome do condutor (busca parcial)", "schema": { "type": "string" } }, { "name": "contratante", "in": "query", "required": false, "description": "string — nome do contratante do serviço de transporte (busca parcial)", "schema": { "type": "string" } }, { "name": "seguradora", "in": "query", "required": false, "description": "string — nome da seguradora da carga (busca parcial)", "schema": { "type": "string" } }, { "name": "municipio_carregamento", "in": "query", "required": false, "description": "string — código IBGE (7 dígitos) do município de carregamento", "schema": { "type": "string" } }, { "name": "municipio_descarregamento", "in": "query", "required": false, "description": "string — código IBGE (7 dígitos) do município de descarregamento", "schema": { "type": "string" } }, { "name": "uf_carregamento", "in": "query", "required": false, "description": "string — UF de início do percurso (ex.: SP)", "schema": { "type": "string" } }, { "name": "uf_descarregamento", "in": "query", "required": false, "description": "string — UF de fim do percurso (ex.: RJ)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "manifestos": { "type": "integer" }, "valor_carga": { "type": "number" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "numero": { "type": "string" }, "serie": { "type": "string" }, "chave": { "type": "string" }, "ambiente": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao": { "type": "string" }, "nome_situacao": { "type": "string" }, "motivo": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "uf_inicio": { "type": "string" }, "uf_fim": { "type": "string" }, "valor_carga": { "type": "number" }, "unidade_carga": { "type": "string" }, "quantidade_carga": { "type": "number" }, "quantidade_nfe": { "type": "number" }, "quantidade_cte": { "type": "number" }, "situacao_email": { "type": "string" }, "nome_situacao_email": { "type": "string" }, "data_situacao_email": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } }, "por_situacao": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "string" }, "nome": { "type": "string" }, "quantidade": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de emissão do manifesto", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 65 ], "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "manifestos": 1, "valor_carga": 18450.9000000000014551915228366851806640625 }, "itens": [ { "id": "1532", "numero": "128", "serie": "1", "chave": "35261000000000000191580010000001281000012345", "ambiente": "1", "loja_id": "65", "nome_loja": "Master", "situacao": "3", "nome_situacao": "Encerrado", "motivo": "Autorizado o uso do MDF-e", "data_emissao": "2026-10-14", "hora_emissao": "08:30", "uf_inicio": "SP", "uf_fim": "RJ", "valor_carga": 18450.9000000000014551915228366851806640625, "unidade_carga": "01", "quantidade_carga": 2350, "quantidade_nfe": 2, "quantidade_cte": 0, "situacao_email": "1", "nome_situacao_email": "Enviado", "data_situacao_email": "2026-10-14", "cadastrado_em": "2026-10-14 08:25:12", "modificado_em": "2026-10-15 17:02:40" } ], "por_situacao": [ { "situacao": "3", "nome": "Encerrado", "quantidade": 1 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Mdfe/Manifestos/index", "x-periodo": { "data": "a data de emissão do manifesto", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "MDF-e é o manifesto do transporte da carga (agrupa NF-e/CT-e de uma viagem) — não é nota fiscal: para notas use /notas_fiscais_produtos ou os relatórios de NF-e. data.totais.manifestos conta os manifestos do período e data.totais.valor_carga soma o valor total da carga declarado neles; data.por_situacao divide a contagem por situação — responda com esses números e cite o período de meta.periodo. Sem ambiente, só entram os de produção: \"nenhum manifesto\" pode ser porque a loja emite em homologação (passe ambiente=2). \"Aprovada\" (1) = autorizado pela SEFAZ e ainda não encerrado (viagem em curso); \"Encerrado\" (3) = viagem concluída. numero é o número do MDF-e (busca sem recorte de período); id é o identificador interno. Condutor, veículo e documentos estão só em /mdfe/{id}. data.itens é só uma página — nunca some as linhas.", "description": "Manifestos eletrônicos (MDF-e) da tela MDF-e > Manifestos, só leitura. A listagem traz os manifestos emitidos no período com o total de manifestos, o valor total da carga e a contagem por situação; o detalhe traz emitente, carga, municípios de carregamento e descarregamento (com as chaves das NF-e e CT-e), percurso, seguro, dados do rodoviário (veículo, condutores, reboques, CIOT, vale-pedágio, contratantes) e pagamento do frete. O XML não sai pela API.\n\nMesmo recorte da tela: empresa da chave e lojas do usuário; exige o recurso MDF-e no plano da loja (402 sem ele). Diferente da tela, que mostra só o ambiente configurado na loja logada, a API usa `ambiente` (padrão 1, produção) — o valor não é ecoado em `meta.filtros` quando fica no padrão. Ordem: número do manifesto decrescente.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de emissão do manifesto. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Mdfe/Manifestos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/mdfe/{id}": { "get": { "tags": [ "MDF-e" ], "summary": "Visualizar manifestos (MDF-e)", "operationId": "mdfe_mdfe_visualizar", "x-modulo": "mdfe", "x-recurso": "mdfe", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "numero": { "type": "string" }, "serie": { "type": "string" }, "chave": { "type": "string" }, "ambiente": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao": { "type": "string" }, "nome_situacao": { "type": "string" }, "motivo": { "type": "string" }, "data_emissao": { "type": "string" }, "hora_emissao": { "type": "string" }, "uf_inicio": { "type": "string" }, "uf_fim": { "type": "string" }, "valor_carga": { "type": "number" }, "unidade_carga": { "type": "string" }, "quantidade_carga": { "type": "number" }, "quantidade_nfe": { "type": "number" }, "quantidade_cte": { "type": "number" }, "situacao_email": { "type": "string" }, "nome_situacao_email": { "type": "string" }, "data_situacao_email": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "protocolo": { "type": "string" }, "codigo_status": { "type": "string" }, "modal": { "type": "string" }, "tipo_emitente": { "type": "string" }, "nome_tipo_emitente": { "type": "string" }, "tipo_transportador": { "type": [ "string", "null" ] }, "nome_tipo_transportador": { "type": [ "string", "null" ] }, "emitente": { "type": "object", "properties": { "cpf_cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "nome": { "type": "string" }, "email": { "type": "string" }, "logradouro": { "type": "string" }, "numero": { "type": "string" }, "bairro": { "type": "string" }, "municipio_codigo": { "type": "string" }, "municipio": { "type": "string" }, "uf": { "type": "string" }, "cep": { "type": "string" } } }, "carga": { "type": "object", "properties": { "tipo": { "type": "string" }, "nome_tipo": { "type": "string" }, "produto": { "type": "string" }, "produto_id": { "type": [ "string", "null" ] }, "ncm": { "type": "string" }, "ean": { "type": [ "string", "null" ] }, "cep_carregamento": { "type": "string" }, "cep_descarregamento": { "type": "string" } } }, "informacoes_fisco": { "type": [ "string", "null" ] }, "informacoes_complementares": { "type": "string" }, "municipios_carregamento": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" } } } }, "percurso": { "type": "object", "properties": [] }, "municipios_descarregamento": { "type": "array", "items": { "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "notas_fiscais": { "type": "array", "items": { "type": "string" } }, "conhecimentos_transporte": { "type": "object", "properties": [] } } } }, "seguros": { "type": "array", "items": { "type": "object", "properties": { "responsavel": { "type": "string" }, "nome_responsavel": { "type": "string" }, "cpf_cnpj_responsavel": { "type": "string" }, "seguradora": { "type": "string" }, "cnpj_seguradora": { "type": "string" }, "apolice": { "type": "string" }, "averbacoes": { "type": "array", "items": { "type": "string" } } } } }, "rodoviario": { "type": "object", "properties": { "rntrc": { "type": "string" }, "categoria_combinacao_veicular": { "type": [ "string", "null" ] }, "nome_categoria_combinacao_veicular": { "type": [ "string", "null" ] }, "codigo_agendamento_porto": { "type": [ "string", "null" ] }, "veiculo": { "type": "object", "properties": { "placa": { "type": "string" }, "uf": { "type": "string" }, "tara": { "type": "number" }, "tipo_rodado": { "type": "string" }, "nome_tipo_rodado": { "type": "string" }, "tipo_carroceria": { "type": "string" }, "nome_tipo_carroceria": { "type": "string" }, "pertence_emitente": { "type": "integer" }, "proprietario": { "type": "object", "properties": { "nome": { "type": [ "string", "null" ] }, "cpf_cnpj": { "type": [ "string", "null" ] }, "inscricao_estadual": { "type": [ "string", "null" ] }, "uf": { "type": [ "string", "null" ] }, "rntrc": { "type": [ "string", "null" ] }, "tipo": { "type": [ "string", "null" ] }, "nome_tipo": { "type": [ "string", "null" ] } } } } }, "condutores": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "cpf": { "type": "string" } } } }, "reboques": { "type": "object", "properties": [] }, "ciot": { "type": "object", "properties": [] }, "vale_pedagio": { "type": "object", "properties": [] }, "contratantes": { "type": "array", "items": { "type": "object", "properties": { "tipo": { "type": "string" }, "nome": { "type": "string" }, "cpf_cnpj": { "type": "string" } } } } } }, "pagamentos": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "1532", "numero": "128", "serie": "1", "chave": "35261000000000000191580010000001281000012345", "ambiente": "1", "loja_id": "65", "nome_loja": "Master", "situacao": "3", "nome_situacao": "Encerrado", "motivo": "Autorizado o uso do MDF-e", "data_emissao": "2026-10-14", "hora_emissao": "08:30", "uf_inicio": "SP", "uf_fim": "RJ", "valor_carga": 18450.9000000000014551915228366851806640625, "unidade_carga": "01", "quantidade_carga": 2350, "quantidade_nfe": 2, "quantidade_cte": 0, "situacao_email": "1", "nome_situacao_email": "Enviado", "data_situacao_email": "2026-10-14", "cadastrado_em": "2026-10-14 08:25:12", "modificado_em": "2026-10-15 17:02:40", "protocolo": "935260000123456", "codigo_status": "100", "modal": "1", "tipo_emitente": "2", "nome_tipo_emitente": "Transportador de carga própria", "tipo_transportador": null, "nome_tipo_transportador": null, "emitente": { "cpf_cnpj": "00.000.000/0001-91", "inscricao_estadual": "000000000000", "nome": "Empresa Exemplo Ltda", "email": "fiscal@exemplo.com.br", "logradouro": "Rua Exemplo", "numero": "100", "bairro": "Centro", "municipio_codigo": "3550308", "municipio": "São Paulo", "uf": "SP", "cep": "01000-000" }, "carga": { "tipo": "05", "nome_tipo": "Carga Geral", "produto": "Materiais de construção", "produto_id": null, "ncm": "68101900", "ean": null, "cep_carregamento": "01000-000", "cep_descarregamento": "20000-000" }, "informacoes_fisco": null, "informacoes_complementares": "Entrega em horário comercial.", "municipios_carregamento": [ { "codigo": "3550308", "nome": "São Paulo" } ], "percurso": [], "municipios_descarregamento": [ { "codigo": "3304557", "nome": "Rio de Janeiro", "notas_fiscais": [ "35261000000000000191550010000045671000045678", "35261000000000000191550010000045681000045689" ], "conhecimentos_transporte": [] } ], "seguros": [ { "responsavel": "1", "nome_responsavel": "Emitente do MDF-e", "cpf_cnpj_responsavel": "00.000.000/0001-91", "seguradora": "Seguradora Exemplo", "cnpj_seguradora": "00.000.000/0002-72", "apolice": "1234567890", "averbacoes": [ "00000000000000000000000000001" ] } ], "rodoviario": { "rntrc": "12345678", "categoria_combinacao_veicular": null, "nome_categoria_combinacao_veicular": null, "codigo_agendamento_porto": null, "veiculo": { "placa": "ABC1D23", "uf": "SP", "tara": 7500, "tipo_rodado": "03", "nome_tipo_rodado": "Cavalo Mecânico", "tipo_carroceria": "02", "nome_tipo_carroceria": "Fechada/Baú", "pertence_emitente": 1, "proprietario": { "nome": null, "cpf_cnpj": null, "inscricao_estadual": null, "uf": null, "rntrc": null, "tipo": null, "nome_tipo": null } }, "condutores": [ { "nome": "Motorista Exemplo", "cpf": "000.000.000-00" } ], "reboques": [], "ciot": [], "vale_pedagio": [], "contratantes": [ { "tipo": "Pessoa Jurídica", "nome": "Cliente Exemplo S/A", "cpf_cnpj": "00.000.000/0003-53" } ] }, "pagamentos": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Mdfe/Manifestos/visualizar", "x-ia": "nome_situacao é a situação atual; motivo é o último retorno da SEFAZ (xMotivo) e protocolo o número do protocolo de autorização. ambiente 2 = homologação (sem valor fiscal). Para baixar o XML ou imprimir o DAMDFE, oriente a tela MDF-e > Manifestos — a API não devolve o XML. Emitir, encerrar e cancelar também são só pela tela.", "description": "404 quando o manifesto não existe, é de outra empresa ou de uma loja que o usuário da chave não acessa. Valores em número (ponto decimal), datas AAAA-MM-DD. `unidade_carga`: 01 = KG, 02 = TON. `municipios_descarregamento[].notas_fiscais` e `conhecimentos_transporte` são as chaves de acesso (44 dígitos) dos documentos transportados.\n\n**Permissão exigida:** `Mdfe/Manifestos/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/contratos": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar contratos", "operationId": "contratos_contratos_listar", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "listar", "parameters": [ { "name": "codigo", "in": "query", "required": false, "description": "int — número do contrato; o mesmo número pode existir em tipos diferentes", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "CO = contrato de serviço, LO = locação, EM = empréstimo, SR = assinatura; outro valor é ignorado (vem tudo)", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int; aceita lista (situacao_id[]=1&situacao_id[]=2). Situação de outra empresa, ou de um tipo diferente do filtro `tipo`, é 400 — ids em `/situacoes_contratos, /situacoes_locacoes, /situacoes_assinaturas`", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "string (AAAA-MM-DD ou DD/MM/AAAA); pode vir sozinha", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string (AAAA-MM-DD ou DD/MM/AAAA); pode vir sozinha", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": "integer" }, "proxima_url": { "type": "string" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "data": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "hora_entrega": { "type": "string" }, "hora_retirada": { "type": "string" }, "valor_frete_retirada": { "type": "string" }, "retirada_cep": { "type": "string" }, "retirada_logradouro": { "type": "string" }, "retirada_numero": { "type": "string" }, "retirada_complemento": { "type": "string" }, "retirada_bairro": { "type": "string" }, "retirada_cidade_id": { "type": "string" }, "retirada_nome_cidade": { "type": "string" }, "retirada_estado": { "type": "string" }, "vigencia_locacao": { "type": "string" }, "tipo_periodo_locacao": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "produtos": { "type": "object", "properties": [] }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 28, "total_paginas": 2, "total_registros_pagina": 20, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": 2, "proxima_url": "/api/contratos?pagina=2" }, "data": [ { "id": "716", "codigo": "91", "tipo": "SR", "cliente_id": "59125", "nome_cliente": "assinatura", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "10.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "10.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 17:22:21", "modificado_em": "2026-09-01 17:22:21", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-11-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "840", "servico_id": "41760", "nome_servico": "teste1", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "10.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "10.00" } } ] }, { "id": "715", "codigo": "90", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 17:01:41", "modificado_em": "2026-09-01 17:01:41", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-10-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "839", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "714", "codigo": "48", "tipo": "SR", "cliente_id": "59122", "nome_cliente": "teste2", "vendedor_id": "131521", "nome_vendedor": "comissao integral", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 16:08:12", "modificado_em": "2026-09-01 16:08:12", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-10-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "838", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "713", "codigo": "47", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 16:00:24", "modificado_em": "2026-09-01 16:00:24", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-10-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "837", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "712", "codigo": "46", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:56:12", "modificado_em": "2026-09-01 15:56:12", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-10-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "836", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "711", "codigo": "45", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:45:01", "modificado_em": "2026-09-01 15:45:01", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-10-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "835", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "710", "codigo": "44", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:44:06", "modificado_em": "2026-09-01 15:44:06", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "834", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "709", "codigo": "43", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:42:12", "modificado_em": "2026-09-01 15:42:12", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "833", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "708", "codigo": "42", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:40:43", "modificado_em": "2026-09-01 15:40:43", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "832", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "707", "codigo": "41", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:39:01", "modificado_em": "2026-09-01 15:39:01", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-09-01", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "831", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "706", "codigo": "40", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "P", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "cadastrado_em": "2026-08-19 10:49:25", "modificado_em": "2026-08-19 10:49:25", "data_entrega": "2026-08-19", "data_retirada": "2026-09-22", "nota_fiscal_servico_id": "", "data": "", "periodicidade": "", "dia_vencimento": "", "proximo_vencimento": "", "gerar_recebimento": "", "limite": "", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-19", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-19 10:49:26" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "830", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "705", "codigo": "17", "tipo": "LO", "cliente_id": "59118", "nome_cliente": "josefo", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536173", "nome_situacao": "", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-07 14:58:52", "modificado_em": "2026-08-07 14:58:52", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-07", "periodicidade": "1 month", "dia_vencimento": "7", "proximo_vencimento": "2026-09-07", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [ { "produto": { "id": "829", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-07", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-07 14:58:52" } } ], "atributos": [], "anexos": [], "servicos": [] }, { "id": "704", "codigo": "39", "tipo": "SR", "cliente_id": "59118", "nome_cliente": "josefo", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-07 14:57:42", "modificado_em": "2026-08-07 15:01:48", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-07", "periodicidade": "1 month", "dia_vencimento": "7", "proximo_vencimento": "2026-10-07", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "828", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "703", "codigo": "38", "tipo": "CO", "cliente_id": "59118", "nome_cliente": "josefo", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "cadastrado_em": "2026-08-07 14:56:56", "modificado_em": "2026-08-07 14:56:56", "data_entrega": "2026-08-07", "data_retirada": "2026-09-05", "nota_fiscal_servico_id": "", "data": "", "periodicidade": "", "dia_vencimento": "", "proximo_vencimento": "", "gerar_recebimento": "", "limite": "", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-07", "valor": "100.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-07", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-07 14:56:56" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "827", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "702", "codigo": "37", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 16:19:08", "modificado_em": "2026-08-04 16:19:08", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-04", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "826", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "701", "codigo": "36", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131523", "nome_vendedor": "comissao ultima parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 16:17:41", "modificado_em": "2026-08-04 16:17:41", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-04", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "825", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "700", "codigo": "35", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 15:49:07", "modificado_em": "2026-08-04 15:49:07", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-04", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "824", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "699", "codigo": "34", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131521", "nome_vendedor": "comissao integral", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 15:46:06", "modificado_em": "2026-08-04 15:46:06", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-04", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "823", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "698", "codigo": "33", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131521", "nome_vendedor": "comissao integral", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 15:45:07", "modificado_em": "2026-08-04 15:45:07", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-04", "periodicidade": "1 month", "dia_vencimento": "5", "proximo_vencimento": "2026-09-05", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [], "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "822", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "697", "codigo": "16", "tipo": "LO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536173", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649405", "nome_forma_pagamento": "Cartao 20%", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-04 15:18:39", "modificado_em": "2026-08-04 15:20:22", "data_entrega": "", "data_retirada": "", "nota_fiscal_servico_id": "", "data": "2026-08-04", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "hora_entrega": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "plano_id": "", "nome_plano": "", "produtos": [ { "produto": { "id": "821", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "Ativo", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:20:22" } }, { "situacao": { "situacao_id": "536172", "nome_situacao": "Em aberto", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:19:52" } }, { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:18:40" } } ], "atributos": [], "anexos": [], "servicos": [] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data do contrato (`data`) ou a de início/entrega (`data_entrega`) — casa em qualquer das duas, porque cada tipo grava numa delas", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Lista os quatro tipos juntos; cada linha traz `tipo` (CO serviço, LO locação, EM empréstimo, SR assinatura). Sem datas vem o histórico inteiro — ao contrário de /contratos_servicos, /locacoes e /assinaturas, que sem datas trazem só o mês atual. Sem situacao_id ficam de fora os contratos em situação marcada para não aparecer na listagem (exibir_listagem = 0 no catálogo de situações): não diga \"todos os contratos\" sem conferir isso. O número (`codigo`) se repete entre tipos (a locação nº 1 e a assinatura nº 1 são contratos diferentes): na busca por número, confira o `tipo` de cada linha ou mande `tipo`. `tipo` fora de CO/LO/EM/SR é ignorado e vem tudo. `valor_total` é o valor contratado, não o recebido. `pagamentos` são as parcelas previstas (vencimento e valor), sem dizer se foram pagas. `situacao_financeiro` = 1 só diz que as parcelas do contrato de serviço foram lançadas no financeiro; em locação e assinatura fica 0 porque a fatura nasce pela recorrência. Pagamento é assunto do financeiro (recebimentos do cliente). A API não informa se o contrato foi enviado ou visualizado por e-mail. data é só uma página: para quantidade e valor somados use os relatórios de contratos, nunca some as linhas.", "description": "Recurso agregado: lista os quatro tipos de contrato (CO contrato de serviço, LO locação, EM empréstimo, SR assinatura). Nas rotas com id o tipo é descoberto pelo próprio registro; no cadastro, informe o campo `tipo`. Cada tipo tem o seu conjunto de campos: CO traz a vigência em data_entrega/data_retirada e itens em `servicos`; LO/EM trazem entrega, retirada e itens em `produtos`; SR traz plano_id/nome_plano e itens em `servicos`.\n\nSem data_inicio/data_fim não há janela padrão: a listagem traz tudo. O período casa em `data` OU em `data_entrega`, porque cada tipo grava a data numa coluna diferente. A página inteira é carregada num find só — o custo em consultas não cresce com o número de linhas. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia. A listagem devolve apenas os tipos que o usuário do token pode ver: cada tipo é atendido por um sub-plugin com permissão própria (GestaoContratos, GestaoLocacoes e GestaoAssinaturas), e o que não estiver liberado fica de fora. Pedir explicitamente um tipo sem permissão é 403, e sem nenhuma das três também.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do contrato (`data`) ou a de início/entrega (`data_entrega`) — casa em qualquer das duas, porque cada tipo grava numa delas. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Cadastrar contratos", "operationId": "contratos_contratos_cadastrar", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "933", "codigo": "224", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536176", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "valor_produtos": "20.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "20.00", "observacoes": "Contrato agregado API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:57", "modificado_em": "2026-09-08 17:08:57", "data_entrega": "2026-09-03", "data_retirada": "", "nota_fiscal_servico_id": "", "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "2026-09-08", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:57" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1183", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "20.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "20.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`tipo` é obrigatório: sem ele não há como escolher em qual tipo o contrato nasce, e assumir um default criaria no tipo errado calado. As demais regras são as do endereço do tipo. `cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Exige ao menos um item em `servicos`. para CO e SR; Exige ao menos um item em `produtos`. para LO e EM. `limite` = 1 encerra por data e exige `limite_data`; `limite` = 2 encerra por repetições e exige `limite_vezes`. `codigo` é opcional: sem ele o nº sai da numeração da loja. Nº repetido é 400, a menos que a empresa permita duplicar (empresas_configuracoes.permitir_duplicar_codigo). Com o header `Idempotency-Key` o nº repetido deixa de ser erro: a resposta é o contrato que já existe com aquele nº, e nenhum segundo é criado. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro. `proximo_vencimento` é obrigatório em locação (LO) e assinatura (SR). `periodicidade` é validada contra o catálogo (`1 day`, `7 days`, `15 days`, `20 days`, `1 month`, `2 months`, `3 months`, `6 months`, `1 year`): valor fora dele é 400. Não existe abreviação — a coluna é varchar e o valor vira o intervalo de um `strtotime()` no cálculo do próximo vencimento, então um valor inventado gravava calado e quebrava o faturamento depois. `gerar_recebimento` segue a mesma regra da `periodicidade` e é validada contra o catálogo (`0 day`, `1 day`, `3 days`, `5 days`, `7 days`, `10 days`, `15 days`, `21 days`, `1 month`): valor fora dele é 400. É opcional — sem ele a fatura nasce no próprio vencimento.\n\n**Campos obrigatórios:** `tipo`, `cliente_id`, `situacao_id`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data_entrega": { "type": "string" }, "observacoes": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } }, "example": { "tipo": "CO", "cliente_id": "59104", "situacao_id": "536176", "data_entrega": "2026-09-03", "observacoes": "Contrato agregado API a4e17f", "valor_produtos": "20.00", "valor_total": "20.00", "servicos": [ { "servico": { "servico_id": "41759", "nome_servico": "Serviço API", "quantidade": "1.00", "valor_venda": "20.00", "valor_total": "20.00" } } ] } } } } } }, "/contratos/{id}": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Visualizar contratos", "operationId": "contratos_contratos_visualizar", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "array", "items": { "type": "object", "properties": { "anexo": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "706", "codigo": "40", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "P", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "cadastrado_em": "2026-08-19 10:49:25", "modificado_em": "2026-08-19 10:49:25", "data_entrega": "2026-08-19", "data_retirada": "2026-09-22", "nota_fiscal_servico_id": "", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-19", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-19 10:49:26" } } ], "atributos": [], "anexos": [ { "anexo": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } ], "servicos": [ { "servico": { "id": "830", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "`historico` traz cada troca de situação com data, observação e usuário: responde \"quando mudou de situação\" e \"quem mudou\". `pagamentos` são as parcelas previstas do contrato (vencimento e valor), não o que foi pago. Responda a situação por `nome_situacao`.", "description": "O visualizar traz o contrato com as coleções filhas: itens, `pagamentos` (parcelas), `atributos`, `historico` (as trocas de situação registradas em contratos_situacoes) e `anexos` (contratos_arquivos). `historico` e `anexos` são só de leitura — enviá-los no cadastro ou na edição é 400. Cada anexo traz a `url` do arquivo; o envio é por `POST /api/contratos/{id}/anexos`. O tipo é redescoberto pelo próprio registro. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Editar contratos", "operationId": "contratos_contratos_editar", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "927", "codigo": "221", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536176", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "", "nome_forma_pagamento": "", "valor_produtos": "150.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "150.00", "observacoes": "Contrato API a4e17f pelo agregado", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:26", "modificado_em": "2026-09-08 17:08:32", "data_entrega": "2026-09-03", "data_retirada": "2027-09-03", "nota_fiscal_servico_id": "", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-10-03", "valor": "150.00", "forma_pagamento_id": "", "nome_forma_pagamento": "", "plano_contas_id": "", "nome_plano_conta": "", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "", "observacao": "Revertido pelo agregado a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:29" } }, { "situacao": { "situacao_id": "536178", "nome_situacao": "Cancelado", "data": "", "observacao": "Alterado pela API a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:28" } }, { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "2026-09-08", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:26" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1175", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "150.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "150.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "O tipo vem do próprio registro — não repita `tipo` na URL nem espere trocá-lo pelo corpo. `cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro. `proximo_vencimento` é obrigatório em locação (LO) e assinatura (SR). `periodicidade` é validada contra o catálogo (`1 day`, `7 days`, `15 days`, `20 days`, `1 month`, `2 months`, `3 months`, `6 months`, `1 year`): valor fora dele é 400. Não existe abreviação — a coluna é varchar e o valor vira o intervalo de um `strtotime()` no cálculo do próximo vencimento, então um valor inventado gravava calado e quebrava o faturamento depois. `gerar_recebimento` segue a mesma regra da `periodicidade` e é validada contra o catálogo (`0 day`, `1 day`, `3 days`, `5 days`, `7 days`, `10 days`, `15 days`, `21 days`, `1 month`): valor fora dele é 400. É opcional — sem ele a fatura nasce no próprio vencimento.\n\n**Campos obrigatórios:** `cliente_id`, `situacao_id`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "observacoes": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" } } } } } } } }, "example": { "cliente_id": "59104", "situacao_id": "536176", "data_entrega": "2026-09-03", "data_retirada": "2027-09-03", "observacoes": "Contrato API a4e17f pelo agregado", "valor_produtos": "150.00", "valor_total": "150.00", "servicos": [ { "servico": { "servico_id": "41759", "nome_servico": "Serviço API", "quantidade": "1.00", "valor_venda": "150.00", "valor_total": "150.00" } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2026-10-03", "valor": "150.00" } } ] } } } } }, "delete": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Deletar contratos", "operationId": "contratos_contratos_deletar", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Contrato removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/contratos/{id}/alterar_situacao": { "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Alterar a situação de contratos", "operationId": "contratos_contratos_alterar_situacao", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "alterar_situacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "932", "codigo": "223", "tipo": "SR", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "situacao_id": "536179", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "valor_produtos": "99.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "99.00", "observacoes": "Assinatura API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:50", "modificado_em": "2026-09-08 17:08:50", "data": "2026-09-03", "periodicidade": "1 month", "dia_vencimento": "3", "proximo_vencimento": "2026-10-03", "gerar_recebimento": "1 month", "limite": "1", "limite_data": "2027-09-03", "limite_vezes": "", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536179", "nome_situacao": "Em aberto", "data": "", "observacao": "Revertida pelo agregado a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:52" } }, { "situacao": { "situacao_id": "536182", "nome_situacao": "Cancelado", "data": "", "observacao": "Alterada pela API a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:51" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1181", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "99.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "99.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "prefeitura", "email" ], "description": "Troca a situação e registra a mudança no histórico do contrato (contratos_situacoes). O `situacao_id` tem de ser do catálogo do tipo e da empresa do token — situação de outro tipo é 400. `observacao` é opcional e vai para a linha do histórico. A resposta é o contrato já com a nova situação.\n\nSituação que lança dispara os mesmos efeitos da tela (financeiro, estoque, geração de fatura, assinatura digital e e-mail de cobrança), conforme o que estiver marcado na situação.\n\n**Campos obrigatórios:** `situacao_id`\n\n**Efeito fora do sistema:** transmite a nota à prefeitura; envia e-mail a terceiros. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "observacao": { "type": "string" } } }, "example": { "situacao_id": "536179", "observacao": "Revertida pelo agregado a4e17f" } } } } } }, "/contratos/gerar_parcelas": { "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Calcular as parcelas de contratos", "operationId": "contratos_contratos_gerar_parcelas", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "gerar_parcelas", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "pagamento": { "data_vencimento": "2026-11-01", "valor": "150.00" } }, { "pagamento": { "data_vencimento": "2026-12-01", "valor": "150.00" } } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Calcula as parcelas ANTES de gravar, para o cliente mandar o resultado em `pagamentos` no cadastro. Nada é persistido.\n\nSó vale para contrato de serviço: locação e assinatura faturam por recorrência (`periodicidade` + `proximo_vencimento` + `limite`), que é outro modelo — por isso o endereço não existe em /locacoes nem em /assinaturas.\n\nEntrada: `valor_total` (obrigatório), `numero_parcelas` (padrão 1), `intervalo_dias` (30 vira \"1 mês\"), `data_primeira_parcela` (Y-m-d; sem ela começa hoje), `condicao_pagamento` (V à vista, P parcelado) e `tipo_parcela` (D divide o total entre as parcelas; qualquer outro repete o valor em cada uma). A sobra dos centavos vai na última parcela.\n\nNeste endereço não há id na URL, então o tipo vem do corpo: `tipo` é obrigatório e só `CO` é aceito.\n\n**Campos obrigatórios:** `tipo`, `valor_total`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo": { "type": "string" }, "valor_total": { "type": "string" }, "numero_parcelas": { "type": "integer" }, "intervalo_dias": { "type": "integer" }, "data_primeira_parcela": { "type": "string" } } }, "example": { "tipo": "CO", "valor_total": "300.00", "numero_parcelas": 2, "intervalo_dias": 30, "data_primeira_parcela": "2026-11-01" } } } } } }, "/contratos/{id}/anexos": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar os anexos de contratos", "operationId": "contratos_contratos_listar_anexos", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "listar_anexos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "id": "880", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" }, { "id": "881", "nome": "Contrato assinado", "arquivo": "9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/9b1d7e3c2a5f4e8d6c0b1a2f3e4d5c6b.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Anexos do contrato na ordem de envio, cada um com a `url` do arquivo. Exige a permissão de visualizar do tipo do contrato (contrato de serviço, locação ou assinatura). Contrato de outra empresa é 404.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Anexar arquivo a contratos", "operationId": "contratos_contratos_anexar", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "anexar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 201, "status": "success", "data": { "id": "880", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } }, "400": { "description": "Sem o campo `arquivo`, mais de um arquivo na requisição ou arquivo vazio" }, "413": { "description": "Arquivo acima do tamanho máximo" }, "415": { "description": "Formato não aceito" }, "422": { "description": "O contrato já tem 10 anexos" } }, "description": "Envio em `multipart/form-data` (não JSON), um arquivo por requisição: `arquivo` e, opcional, `nome`. Regras do sistema: até 5.048.576 bytes (cerca de 4,8 MB) por arquivo; formatos jpg, jpeg, png, gif, bmp, tiff, pdf, doc, docx, xls, xlsx, csv, txt, html, htm, xml, ofx, pfx, zip, rar; até 10 anexos por contrato. Arquivo maior é 413, formato fora da lista é 415 e o 11º anexo é 422. Contrato de outra empresa é 404. Exige a permissão de editar do tipo do contrato (contrato de serviço, locação ou assinatura); não depende da situação.\n\nExemplo: `curl -X POST https:///api/contratos/123/anexos -H 'access-token: …' -H 'secret-access-token: …' -F 'arquivo=@comprovante.pdf' -F 'nome=Comprovante'`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "arquivo": { "type": "string", "format": "binary", "description": "O arquivo. Um por requisição." }, "nome": { "type": "string", "description": "Nome exibido (até 100 caracteres). Sem ele, fica o nome do arquivo." } }, "required": [ "arquivo" ] } } } } } }, "/contratos/{id}/anexos/{anexo_id}": { "delete": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Excluir um anexo de contratos", "operationId": "contratos_contratos_deletar_anexo", "x-modulo": "contratos", "x-recurso": "contratos", "x-operacao": "deletar_anexo", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } }, { "name": "anexo_id", "in": "path", "required": true, "description": "Identificador do anexo", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "880", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Apaga o anexo e o arquivo. Anexo que não é deste contrato é 404. Exige a permissão de editar do tipo do contrato (contrato de serviço, locação ou assinatura).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/contratos_servicos": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar contratos de serviço", "operationId": "contratos_contratos_servicos_listar", "x-modulo": "contratos", "x-recurso": "contratos_servicos", "x-operacao": "listar", "parameters": [ { "name": "codigo", "in": "query", "required": false, "description": "int — número do contrato. NÃO ignora o período: sem datas só acha contrato com início no mês atual", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — id do cliente", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — parte do nome, razão social ou nome social do cliente", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int; aceita lista. Situação de outra empresa ou de outro tipo é 400 — ids em `/situacoes_contratos`", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — mande junto com data_fim: só uma das duas volta ao mês atual", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — mande junto com data_inicio", "schema": { "type": "string" } }, { "name": "tipo_periodo", "in": "query", "required": false, "description": "a que data o período se refere: inicio (padrão, data de início), termino (data de término) ou vigencia (contrato em vigor em algum dia do período). Com tipo_periodo e sem datas não há recorte: vem o histórico inteiro", "schema": { "type": "string" } }, { "name": "data_inicio_r", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — data de término a partir de; filtra junto com o período", "schema": { "type": "string" } }, { "name": "data_fim_r", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — data de término até", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "string — parte do nome do serviço do contrato (cada palavra precisa aparecer); não aceita id", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "string — mesmo efeito de `servico` (busca no nome do item)", "schema": { "type": "string" } }, { "name": "atributo", "in": "query", "required": false, "description": "atributo[]=valor — contratos com aquele valor no campo extra — ids em `/atributos_contratos`", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 7, "total_paginas": 1, "total_registros_pagina": 7, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "706", "codigo": "40", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-08-19", "data_retirada": "2026-09-22", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "P", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-08-19 10:49:25", "modificado_em": "2026-08-19 10:49:25", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-19", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-19 10:49:26" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "830", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "703", "codigo": "38", "tipo": "CO", "cliente_id": "59118", "nome_cliente": "josefo", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-08-07", "data_retirada": "2026-09-05", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-08-07 14:56:56", "modificado_em": "2026-08-07 14:56:56", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-07", "valor": "100.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-07", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-07 14:56:56" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "827", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "693", "codigo": "32", "tipo": "CO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-08-04", "data_retirada": "2027-08-20", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-08-04 11:51:05", "modificado_em": "2026-08-04 11:52:26", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-04", "valor": "100.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 11:52:26" } }, { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 11:52:03" } }, { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 11:51:05" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "817", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "692", "codigo": "31", "tipo": "CO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131523", "nome_vendedor": "comissao ultima parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-08-04", "data_retirada": "2026-08-31", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-08-04 11:49:07", "modificado_em": "2026-08-04 11:51:26", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-04", "valor": "100.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 11:49:08" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "816", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "691", "codigo": "30", "tipo": "CO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-08-04", "data_retirada": "2027-07-22", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-08-04 11:46:29", "modificado_em": "2026-08-04 11:46:29", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-04", "valor": "100.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 11:46:29" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "815", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "690", "codigo": "29", "tipo": "CO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131521", "nome_vendedor": "comissao integral", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-08-05", "data_retirada": "2026-10-31", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-08-04 11:43:22", "modificado_em": "2026-08-04 11:43:22", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-04", "valor": "100.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 11:43:22" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "814", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "650", "codigo": "1", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "131463", "nome_vendedor": "agenda", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-07-03", "data_retirada": "2026-07-04", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-07-03 17:41:51", "modificado_em": "2026-07-03 17:41:51", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-07-03", "valor": "100.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-07-03", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-07-03 17:41:52" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "774", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data de entrega do contrato (`data_entrega`, início da vigência)", "padrao": "mês atual", "teto_meses": 0 }, "x-ia": "Contratos de serviço linha a linha. Sem datas vem só o mês atual pela data de INÍCIO (data_entrega): para \"contratos vigentes\" use tipo_periodo=vigencia com as datas; para contrato antigo mande o período largo. A busca por `codigo` NÃO ignora o período: sem datas um contrato iniciado em outro mês volta \"Não há dados!\" — mande datas largas junto (ex.: 2000-01-01 a 2030-12-31). Mande data_inicio e data_fim juntas: só uma delas volta ao mês atual. Sem situacao_id ficam de fora os contratos em situação com exibir_listagem = 0. `valor_total` é o contratado, não o recebido; `pagamentos` são as parcelas previstas, sem dizer se foram pagas; `situacao_financeiro` = 1 quer dizer parcelas lançadas no financeiro, não pagas. A API não informa se o contrato foi enviado ou visualizado pelo cliente por e-mail. Para quantidade e valor do período use relatorio_contratos_servicos, já somado; nunca some as linhas.", "description": "Contratos de serviço (tipo CO). Atalho de /contratos restrito a esse tipo. A vigência é `data_entrega` (início) e `data_retirada` (fim) — o contrato de serviço não usa `Contrato.data`, não é recorrente e não tem entrega física. Os itens vão em `servicos`.\n\nSem data_inicio/data_fim a listagem fica no mês corrente, filtrando por `data_entrega`. A página inteira é carregada num find só — o custo em consultas não cresce com o número de linhas. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de entrega do contrato (`data_entrega`, início da vigência). Sem elas: mês atual. Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Cadastrar contratos de serviço", "operationId": "contratos_contratos_servicos_cadastrar", "x-modulo": "contratos", "x-recurso": "contratos_servicos", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "927", "codigo": "221", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-09-03", "data_retirada": "2027-09-03", "situacao_id": "536176", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "", "nome_forma_pagamento": "", "valor_produtos": "150.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "150.00", "observacoes": "Contrato API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-09-08 17:08:26", "modificado_em": "2026-09-08 17:08:26", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-10-03", "valor": "150.00", "forma_pagamento_id": "", "nome_forma_pagamento": "", "plano_contas_id": "", "nome_plano_conta": "", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "2026-09-08", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:26" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1173", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "150.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "150.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Exige ao menos um item em `servicos`. `codigo` é opcional: sem ele o nº sai da numeração da loja. Nº repetido é 400, a menos que a empresa permita duplicar (empresas_configuracoes.permitir_duplicar_codigo). Com o header `Idempotency-Key` o nº repetido deixa de ser erro: a resposta é o contrato que já existe com aquele nº, e nenhum segundo é criado. Não são aceitos: `data`, `periodicidade`, `dia_vencimento`, `proximo_vencimento`, `gerar_recebimento`, `limite`, `limite_data`, `limite_vezes`, `plano_id`, `nome_plano`, `produtos` e os campos de entrega/retirada da locação. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro.\n\n**Campos obrigatórios:** `cliente_id`, `situacao_id`, `servicos`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "observacoes": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" } } } } } } } }, "example": { "cliente_id": "59104", "situacao_id": "536176", "data_entrega": "2026-09-03", "data_retirada": "2027-09-03", "observacoes": "Contrato API a4e17f", "valor_produtos": "150.00", "valor_total": "150.00", "servicos": [ { "servico": { "servico_id": "41759", "nome_servico": "Serviço API", "quantidade": "1.00", "valor_venda": "150.00", "valor_total": "150.00" } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2026-10-03", "valor": "150.00" } } ] } } } } } }, "/contratos_servicos/{id}": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Visualizar contratos de serviço", "operationId": "contratos_contratos_servicos_visualizar", "x-modulo": "contratos", "x-recurso": "contratos_servicos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "array", "items": { "type": "object", "properties": { "anexo": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "706", "codigo": "40", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-08-19", "data_retirada": "2026-09-22", "situacao_id": "536177", "nome_situacao": "Confirmado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "P", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "1", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-08-19 10:49:25", "modificado_em": "2026-08-19 10:49:25", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } }, { "pagamento": { "data_vencimento": "2026-08-19", "valor": "25.00", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "plano_contas_id": "12873354", "nome_plano_conta": "Contratos de serviços", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536177", "nome_situacao": "Confirmado", "data": "2026-08-19", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-19 10:49:26" } } ], "atributos": [], "anexos": [ { "anexo": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } ], "servicos": [ { "servico": { "id": "830", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "`historico` traz cada troca de situação com data, observação e usuário: responde \"quando mudou de situação\". `pagamentos` são as parcelas previstas (vencimento e valor), não o que foi pago. Vigência: `data_entrega` é o início e `data_retirada` o término.", "description": "O visualizar traz o contrato com as coleções filhas: itens, `pagamentos` (parcelas), `atributos`, `historico` (as trocas de situação registradas em contratos_situacoes) e `anexos` (contratos_arquivos). `historico` e `anexos` são só de leitura — enviá-los no cadastro ou na edição é 400. Cada anexo traz a `url` do arquivo; o envio é por `POST /api/contratos/{id}/anexos`. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Editar contratos de serviço", "operationId": "contratos_contratos_servicos_editar", "x-modulo": "contratos", "x-recurso": "contratos_servicos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "927", "codigo": "221", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-09-03", "data_retirada": "2027-09-03", "situacao_id": "536176", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "", "nome_forma_pagamento": "", "valor_produtos": "150.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "150.00", "observacoes": "Contrato API a4e17f editado", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-09-08 17:08:26", "modificado_em": "2026-09-08 17:08:30", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-10-03", "valor": "150.00", "forma_pagamento_id": "", "nome_forma_pagamento": "", "plano_contas_id": "", "nome_plano_conta": "", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "", "observacao": "Revertido pelo agregado a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:29" } }, { "situacao": { "situacao_id": "536178", "nome_situacao": "Cancelado", "data": "", "observacao": "Alterado pela API a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:28" } }, { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "2026-09-08", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:26" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1174", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "150.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "150.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "A edição substitui o contrato inteiro: mande o payload completo, inclusive `servicos` e `pagamentos`. `cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro.\n\n**Campos obrigatórios:** `cliente_id`, `situacao_id`, `servicos`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "observacoes": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" } } } } } } } }, "example": { "cliente_id": "59104", "situacao_id": "536176", "data_entrega": "2026-09-03", "data_retirada": "2027-09-03", "observacoes": "Contrato API a4e17f editado", "valor_produtos": "150.00", "valor_total": "150.00", "servicos": [ { "servico": { "servico_id": "41759", "nome_servico": "Serviço API", "quantidade": "1.00", "valor_venda": "150.00", "valor_total": "150.00" } } ], "pagamentos": [ { "pagamento": { "data_vencimento": "2026-10-03", "valor": "150.00" } } ] } } } } }, "delete": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Deletar contratos de serviço", "operationId": "contratos_contratos_servicos_deletar", "x-modulo": "contratos", "x-recurso": "contratos_servicos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Contrato removido com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/contratos_servicos/{id}/alterar_situacao": { "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Alterar a situação de contratos de serviço", "operationId": "contratos_contratos_servicos_alterar_situacao", "x-modulo": "contratos", "x-recurso": "contratos_servicos", "x-operacao": "alterar_situacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "nota_fiscal_servico_id": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "pagamentos": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "observacao": { "type": "string" } } } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "927", "codigo": "221", "tipo": "CO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data_entrega": "2026-09-03", "data_retirada": "2027-09-03", "situacao_id": "536178", "nome_situacao": "Cancelado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "V", "forma_pagamento_id": "", "nome_forma_pagamento": "", "valor_produtos": "150.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "150.00", "observacoes": "Contrato API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "nota_fiscal_servico_id": "", "cadastrado_em": "2026-09-08 17:08:26", "modificado_em": "2026-09-08 17:08:28", "pagamentos": [ { "pagamento": { "data_vencimento": "2026-10-03", "valor": "150.00", "forma_pagamento_id": "", "nome_forma_pagamento": "", "plano_contas_id": "", "nome_plano_conta": "", "observacao": "" } } ], "historico": [ { "situacao": { "situacao_id": "536178", "nome_situacao": "Cancelado", "data": "", "observacao": "Alterado pela API a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:28" } }, { "situacao": { "situacao_id": "536176", "nome_situacao": "Em aberto", "data": "2026-09-08", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:26" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1173", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "150.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "150.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "prefeitura", "email" ], "description": "Troca a situação e registra a mudança no histórico do contrato (contratos_situacoes). O `situacao_id` tem de ser do catálogo do tipo e da empresa do token — situação de outro tipo é 400. `observacao` é opcional e vai para a linha do histórico. A resposta é o contrato já com a nova situação.\n\nSituação que lança dispara os mesmos efeitos da tela (financeiro, estoque, geração de fatura, assinatura digital e e-mail de cobrança), conforme o que estiver marcado na situação.\n\n**Campos obrigatórios:** `situacao_id`\n\n**Efeito fora do sistema:** transmite a nota à prefeitura; envia e-mail a terceiros. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "observacao": { "type": "string" } } }, "example": { "situacao_id": "536178", "observacao": "Alterado pela API a4e17f" } } } } } }, "/contratos_servicos/gerar_parcelas": { "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Calcular as parcelas de contratos de serviço", "operationId": "contratos_contratos_servicos_gerar_parcelas", "x-modulo": "contratos", "x-recurso": "contratos_servicos", "x-operacao": "gerar_parcelas", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "pagamento": { "type": "object", "properties": { "data_vencimento": { "type": "string" }, "valor": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": [ { "pagamento": { "data_vencimento": "2026-10-05", "valor": "333.33" } }, { "pagamento": { "data_vencimento": "2026-11-05", "valor": "333.33" } }, { "pagamento": { "data_vencimento": "2026-12-05", "valor": "333.34" } } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Calcula as parcelas ANTES de gravar, para o cliente mandar o resultado em `pagamentos` no cadastro. Nada é persistido.\n\nSó vale para contrato de serviço: locação e assinatura faturam por recorrência (`periodicidade` + `proximo_vencimento` + `limite`), que é outro modelo — por isso o endereço não existe em /locacoes nem em /assinaturas.\n\nEntrada: `valor_total` (obrigatório), `numero_parcelas` (padrão 1), `intervalo_dias` (30 vira \"1 mês\"), `data_primeira_parcela` (Y-m-d; sem ela começa hoje), `condicao_pagamento` (V à vista, P parcelado) e `tipo_parcela` (D divide o total entre as parcelas; qualquer outro repete o valor em cada uma). A sobra dos centavos vai na última parcela.\n\n**Campos obrigatórios:** `valor_total`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "valor_total": { "type": "string" }, "numero_parcelas": { "type": "integer" }, "intervalo_dias": { "type": "integer" }, "data_primeira_parcela": { "type": "string" } } }, "example": { "valor_total": "1000.00", "numero_parcelas": 3, "intervalo_dias": 30, "data_primeira_parcela": "2026-10-05" } } } } } }, "/situacoes_contratos": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar situações de contratos de serviço", "operationId": "contratos_situacoes_contratos_listar", "x-modulo": "contratos", "x-recurso": "situacoes_contratos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string; casa por trecho do nome (LIKE)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "string" }, "padrao": { "type": "string" }, "tipo_lancamento": { "type": "string" }, "lancar_nfse": { "type": "string" }, "gerar_assinatura": { "type": "string" }, "enviar_cobranca_email": { "type": "string" }, "exibir_listagem": { "type": "string" }, "exibir_cobranca": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 3, "total_paginas": 1, "total_registros_pagina": 3, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "536176", "nome": "Em aberto", "tipo": "CO", "cor": "#999999", "ordem": "1", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536177", "nome": "Confirmado", "tipo": "CO", "cor": "#5cb85c", "ordem": "2", "padrao": "1", "tipo_lancamento": "1", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-08-04 10:48:20" }, { "id": "536178", "nome": "Cancelado", "tipo": "CO", "cor": "#d9534f", "ordem": "3", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Situações são cadastradas por empresa (não há lista fixa): pegue aqui o `id` para o filtro situacao_id e responda pelo `nome`. `exibir_listagem` = 0: os registros nessa situação somem da listagem quando ela não é filtrada por situação. `tipo_lancamento` = 1: a situação lança as parcelas no financeiro. Só serve para /contratos_servicos e contratos tipo CO.", "description": "Catálogo de situações do tipo CO. É a fonte do `situacao_id` aceito no cadastro, na edição e no alterar_situacao de /api/contratos_servicos e /api/contratos (tipo CO) — situação de outro tipo ou de outra empresa é 400. Também é a fonte do filtro `situacao_id` da listagem.\n\n**`tipo_lancamento`** (coluna `lancar`) em contrato de serviço\n\n| valor | significado |\n|---|---|\n| 0 | não gera financeiro |\n| 1 | gera financeiro |\n\nEscopado pela empresa do token — o catálogo de uma empresa nunca aparece para outra, e um id de outra empresa responde 404.\n\nOs enums saem com o **valor literal do banco**; a tradução está aqui, não na resposta.\n\n**Campos comuns a qualquer situação**\n\n| campo | valor | significado |\n|---|---|---|\n| `padrao` | 0 | não utilizar como padrão |\n| | 1 | padrão de inicialização (a situação que o cadastro assume) |\n| | 2 | padrão de finalização |\n| `lancar_nfse` | 0 | não gerar NFS-e |\n| | 1 | gerar NFS-e sem emitir |\n| | 2 | gerar e emitir NFS-e |\n| `gerar_assinatura` | 0 | não gerar assinatura digital |\n| | 1 | gerar assinatura digital |\n| `enviar_cobranca_email` | 0 | não enviar e-mail |\n| | 1 | enviar impressão em PDF |\n| | 2 | enviar link de cobrança |\n| `exibir_listagem` | 0 / 1 | some da listagem quando não filtrada por situação / aparece |\n| `exibir_cobranca` | 0 / 1 | não aparece / aparece na área de cobrança do cliente |\n\n`cor` é hexadecimal (`#5cb85c`) e `ordem` é a posição na tela.\n\nExige a mesma permissão da tela correspondente (GestaoContratos); sem ela a resposta é 403.\n\n⚠️ **Mudança de comportamento** (PRD-162): até a versão anterior estes dois endereços devolviam as situações de TODOS os tipos de contrato da empresa, inclusive as sem tipo. Agora cada um devolve só o catálogo do seu tipo, e a coluna `tipo` passou a sair no payload. Quem filtrava a lista no cliente pode remover o filtro; quem dependia de receber os outros tipos precisa chamar também /situacoes_locacoes ou /situacoes_assinaturas.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/locacoes": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar locações e empréstimos", "operationId": "contratos_locacoes_listar", "x-modulo": "contratos", "x-recurso": "locacoes", "x-operacao": "listar", "parameters": [ { "name": "codigo", "in": "query", "required": false, "description": "int — número da locação. NÃO ignora o período: sem datas só acha locação com data no mês atual", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "LO = locação, EM = empréstimo (outro valor é 400; sem tipo, os dois)", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — id do cliente (não há busca por nome do cliente aqui)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int; aceita lista. Situação de outra empresa ou de outro tipo é 400 — ids em `/situacoes_locacoes`", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — data da locação a partir de; pode vir sozinha", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — data da locação até; pode vir sozinha", "schema": { "type": "string" } }, { "name": "forma-pagamento", "in": "query", "required": false, "description": "int — id da forma de pagamento (com hífen: `forma_pagamento_id` é ignorado nesta listagem)", "schema": { "type": "string" } }, { "name": "gerar-fatura", "in": "query", "required": false, "description": "string — antecedência da geração da fatura, igual ao campo `gerar_recebimento` (ex.: `5 days`, `0 day`)", "schema": { "type": "string" } }, { "name": "envio", "in": "query", "required": false, "description": "configuração de envio da fatura por e-mail: 0 = não envia, 1 = lembrete de pagamento e boleto, 2 = só o lembrete. Não diz se o e-mail saiu", "schema": { "type": "string" } }, { "name": "atributo", "in": "query", "required": false, "description": "atributo[]=valor — locações com aquele valor no campo extra — ids em `/atributos_contratos`", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "hora_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "hora_retirada": { "type": "string" }, "valor_frete_retirada": { "type": "string" }, "retirada_cep": { "type": "string" }, "retirada_logradouro": { "type": "string" }, "retirada_numero": { "type": "string" }, "retirada_complemento": { "type": "string" }, "retirada_bairro": { "type": "string" }, "retirada_cidade_id": { "type": "string" }, "retirada_nome_cidade": { "type": "string" }, "retirada_estado": { "type": "string" }, "vigencia_locacao": { "type": "string" }, "tipo_periodo_locacao": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 5, "total_paginas": 1, "total_registros_pagina": 5, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "705", "codigo": "17", "tipo": "LO", "cliente_id": "59118", "nome_cliente": "josefo", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-07", "situacao_id": "536173", "nome_situacao": "", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "7", "proximo_vencimento": "2026-09-07", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-07 14:58:52", "modificado_em": "2026-08-07 14:58:52", "data_entrega": "", "hora_entrega": "", "data_retirada": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "id": "829", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-07", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-07 14:58:52" } } ], "atributos": [], "anexos": [] }, { "id": "697", "codigo": "16", "tipo": "LO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536173", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649405", "nome_forma_pagamento": "Cartao 20%", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-04 15:18:39", "modificado_em": "2026-08-04 15:20:22", "data_entrega": "", "hora_entrega": "", "data_retirada": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "id": "821", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "Ativo", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:20:22" } }, { "situacao": { "situacao_id": "536172", "nome_situacao": "Em aberto", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:19:52" } }, { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:18:40" } } ], "atributos": [], "anexos": [] }, { "id": "696", "codigo": "15", "tipo": "LO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131523", "nome_vendedor": "comissao ultima parcela", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536173", "nome_situacao": "", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "5", "proximo_vencimento": "2026-09-05", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-04 15:16:33", "modificado_em": "2026-08-04 15:16:33", "data_entrega": "", "hora_entrega": "", "data_retirada": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "id": "820", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:16:34" } } ], "atributos": [], "anexos": [] }, { "id": "695", "codigo": "14", "tipo": "LO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536173", "nome_situacao": "", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "5", "proximo_vencimento": "2026-09-05", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-04 15:13:38", "modificado_em": "2026-08-04 15:13:38", "data_entrega": "", "hora_entrega": "", "data_retirada": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "id": "819", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:13:39" } } ], "atributos": [], "anexos": [] }, { "id": "694", "codigo": "13", "tipo": "LO", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131521", "nome_vendedor": "comissao integral", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536173", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "5", "proximo_vencimento": "2026-09-05", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-04 15:10:11", "modificado_em": "2026-08-04 15:10:57", "data_entrega": "", "hora_entrega": "", "data_retirada": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "id": "818", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "Ativo", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:10:57" } }, { "situacao": { "situacao_id": "536172", "nome_situacao": "Em aberto", "data": "", "observacao": "", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:10:31" } }, { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-04", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-04 15:10:12" } } ], "atributos": [], "anexos": [] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "a data da locação (`data`)", "padrao": "mês atual", "teto_meses": 0 }, "x-ia": "Locações e empréstimos linha a linha. Sem datas vem só o mês atual pela DATA DA LOCAÇÃO (`data`): \"locações ativas\" ou \"o que está com o cliente\" sem datas esconde as feitas em outros meses — mande o período largo e filtre a situação. A busca por `codigo` NÃO ignora o período: mande datas largas junto (ex.: 2000-01-01 a 2030-12-31). Sem situacao_id ficam de fora as locações em situação com exibir_listagem = 0. Onde está o produto e se gera fatura vem da situação (tipo_lancamento em /situacoes_locacoes), não do nome dela. `valor_total` é o valor de cada fatura da locação (uma por `periodicidade`), não o recebido; `situacao_financeiro` fica 0 em locação (a fatura nasce pela recorrência). A API não informa se a fatura foi enviada ou visualizada por e-mail. Para totais use relatorio_locacoes_clientes ou relatorio_produtos_locados; nunca some as linhas.", "description": "Locações (tipo LO) e empréstimos (tipo EM) — os dois saem do mesmo recurso; informe `tipo` no corpo para cadastrar um empréstimo. Só estes tipos trazem os campos de entrega e retirada (data_entrega, hora_entrega, data_retirada, hora_retirada, valor_frete_retirada e o endereço retirada_*). Os itens vão em `produtos`.\n\nSem data_inicio/data_fim a listagem fica no mês corrente, filtrando por `data`. A página inteira é carregada num find só — o custo em consultas não cresce com o número de linhas. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data da locação (`data`). Sem elas: mês atual. Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Cadastrar locações e empréstimos", "operationId": "contratos_locacoes_cadastrar", "x-modulo": "contratos", "x-recurso": "locacoes", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "hora_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "hora_retirada": { "type": "string" }, "valor_frete_retirada": { "type": "string" }, "retirada_cep": { "type": "string" }, "retirada_logradouro": { "type": "string" }, "retirada_numero": { "type": "string" }, "retirada_complemento": { "type": "string" }, "retirada_bairro": { "type": "string" }, "retirada_cidade_id": { "type": "string" }, "retirada_nome_cidade": { "type": "string" }, "retirada_estado": { "type": "string" }, "vigencia_locacao": { "type": "string" }, "tipo_periodo_locacao": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "931", "codigo": "94", "tipo": "LO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-03", "situacao_id": "536172", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "periodicidade": "1 month", "dia_vencimento": "3", "proximo_vencimento": "2026-10-03", "gerar_recebimento": "1 month", "limite": "2", "limite_data": "", "limite_vezes": "3", "valor_produtos": "50.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "50.00", "observacoes": "Locação API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:43", "modificado_em": "2026-09-08 17:08:43", "data_entrega": "2026-09-04", "hora_entrega": "08:00:00", "data_retirada": "2026-09-20", "hora_retirada": "18:00:00", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "produto_id": "41800", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "quantidade": "1.00", "valor_venda": "50.00", "valor_total": "50.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Exige ao menos um item em `produtos`. `limite` = 1 encerra por data e exige `limite_data`; `limite` = 2 encerra por repetições e exige `limite_vezes`. `codigo` não é aceito no corpo: o nº da locação sai da numeração da loja (lojas_configuracoes.numeracao_locacao) e é imutável pela API. `tipo` aceita só LO ou EM. Não são aceitos: `codigo`, `servicos`, `plano_id`, `nome_plano` e `nota_fiscal_servico_id`. Empréstimo usa o mesmo catálogo de situações da locação — não existe situação com tipo EM. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro. `proximo_vencimento` é obrigatório em locação (não em empréstimo): o sistema deriva o `dia_vencimento` a partir dele. `periodicidade` é validada contra o catálogo (`1 day`, `7 days`, `15 days`, `20 days`, `1 month`, `2 months`, `3 months`, `6 months`, `1 year`): valor fora dele é 400. Não existe abreviação — a coluna é varchar e o valor vira o intervalo de um `strtotime()` no cálculo do próximo vencimento, então um valor inventado gravava calado e quebrava o faturamento depois. `gerar_recebimento` segue a mesma regra da `periodicidade` e é validada contra o catálogo (`0 day`, `1 day`, `3 days`, `5 days`, `7 days`, `10 days`, `15 days`, `21 days`, `1 month`): valor fora dele é 400. É opcional — sem ele a fatura nasce no próprio vencimento.\n\n**Campos obrigatórios:** `cliente_id`, `situacao_id`, `produtos`, `proximo_vencimento`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "periodicidade": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "integer" }, "limite_vezes": { "type": "integer" }, "observacoes": { "type": "string" }, "data_entrega": { "type": "string" }, "hora_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "hora_retirada": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" }, "movimenta_estoque": { "type": "integer" } } } } } } } }, "example": { "cliente_id": "59104", "situacao_id": "536172", "data": "2026-09-03", "proximo_vencimento": "2026-10-03", "periodicidade": "1 month", "gerar_recebimento": "1 month", "limite": 2, "limite_vezes": 3, "observacoes": "Locação API a4e17f", "data_entrega": "2026-09-04", "hora_entrega": "08:00:00", "data_retirada": "2026-09-20", "hora_retirada": "18:00:00", "valor_produtos": "50.00", "valor_total": "50.00", "produtos": [ { "produto": { "produto_id": "41800", "nome_produto": "Produto API", "quantidade": "1.00", "valor_venda": "50.00", "valor_total": "50.00", "movimenta_estoque": 0 } } ] } } } } } }, "/locacoes/{id}": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Visualizar locações e empréstimos", "operationId": "contratos_locacoes_visualizar", "x-modulo": "contratos", "x-recurso": "locacoes", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "hora_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "hora_retirada": { "type": "string" }, "valor_frete_retirada": { "type": "string" }, "retirada_cep": { "type": "string" }, "retirada_logradouro": { "type": "string" }, "retirada_numero": { "type": "string" }, "retirada_complemento": { "type": "string" }, "retirada_bairro": { "type": "string" }, "retirada_cidade_id": { "type": "string" }, "retirada_nome_cidade": { "type": "string" }, "retirada_estado": { "type": "string" }, "vigencia_locacao": { "type": "string" }, "tipo_periodo_locacao": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "id": { "type": "string" }, "produto_id": { "type": "string" }, "variacao_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "movimenta_estoque": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "array", "items": { "type": "object", "properties": { "anexo": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "705", "codigo": "17", "tipo": "LO", "cliente_id": "59118", "nome_cliente": "josefo", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-07", "situacao_id": "536173", "nome_situacao": "", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873355", "nome_plano_conta": "Locação de equipamentos", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "7", "proximo_vencimento": "2026-09-07", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "0.00", "desconto_valor": "0.00", "desconto_porcentagem": "0.00", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "1", "cadastrado_em": "2026-08-07 14:58:52", "modificado_em": "2026-08-07 14:58:52", "data_entrega": "", "hora_entrega": "", "data_retirada": "", "hora_retirada": "", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "id": "829", "produto_id": "41800", "variacao_id": "307510", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "movimenta_estoque": "1", "quantidade": "1.00", "unidade": "UN", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ], "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536173", "nome_situacao": "", "data": "2026-08-07", "observacao": "Contrato cadastrado", "nome_usuario": "agenda", "cadastrado_em": "2026-08-07 14:58:52" } } ], "atributos": [], "anexos": [ { "anexo": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "`historico` traz cada troca de situação com data, observação e usuário. `proximo_vencimento` é o vencimento da próxima fatura e `valor_total` o valor de cada fatura (muda quando há devolução de produto). Responda a situação por `nome_situacao`.", "description": "O visualizar traz o contrato com as coleções filhas: itens, `pagamentos` (parcelas), `atributos`, `historico` (as trocas de situação registradas em contratos_situacoes) e `anexos` (contratos_arquivos). `historico` e `anexos` são só de leitura — enviá-los no cadastro ou na edição é 400. Cada anexo traz a `url` do arquivo; o envio é por `POST /api/contratos/{id}/anexos`. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Editar locações e empréstimos", "operationId": "contratos_locacoes_editar", "x-modulo": "contratos", "x-recurso": "locacoes", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "hora_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "hora_retirada": { "type": "string" }, "valor_frete_retirada": { "type": "string" }, "retirada_cep": { "type": "string" }, "retirada_logradouro": { "type": "string" }, "retirada_numero": { "type": "string" }, "retirada_complemento": { "type": "string" }, "retirada_bairro": { "type": "string" }, "retirada_cidade_id": { "type": "string" }, "retirada_nome_cidade": { "type": "string" }, "retirada_estado": { "type": "string" }, "vigencia_locacao": { "type": "string" }, "tipo_periodo_locacao": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "931", "codigo": "94", "tipo": "LO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-03", "situacao_id": "536172", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "periodicidade": "1 month", "dia_vencimento": "3", "proximo_vencimento": "2026-10-03", "gerar_recebimento": "1 month", "limite": "2", "limite_data": "", "limite_vezes": "3", "valor_produtos": "50.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "50.00", "observacoes": "Locação API a4e17f editada", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:43", "modificado_em": "2026-09-08 17:08:47", "data_entrega": "2026-09-04", "hora_entrega": "08:00:00", "data_retirada": "2026-09-20", "hora_retirada": "18:00:00", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "produto_id": "41800", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "quantidade": "1.00", "valor_venda": "50.00", "valor_total": "50.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "A edição substitui a locação inteira: mande o payload completo. O nº e o tipo não mudam. Locação numa situação que lança (ex.: \"Ativo\") não pode ser editada nem removida — é regra do LocacaoComponent, a mesma da tela. `cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro. `proximo_vencimento` é obrigatório em locação (não em empréstimo): o sistema deriva o `dia_vencimento` a partir dele. `periodicidade` é validada contra o catálogo (`1 day`, `7 days`, `15 days`, `20 days`, `1 month`, `2 months`, `3 months`, `6 months`, `1 year`): valor fora dele é 400. Não existe abreviação — a coluna é varchar e o valor vira o intervalo de um `strtotime()` no cálculo do próximo vencimento, então um valor inventado gravava calado e quebrava o faturamento depois. `gerar_recebimento` segue a mesma regra da `periodicidade` e é validada contra o catálogo (`0 day`, `1 day`, `3 days`, `5 days`, `7 days`, `10 days`, `15 days`, `21 days`, `1 month`): valor fora dele é 400. É opcional — sem ele a fatura nasce no próprio vencimento.\n\n**Campos obrigatórios:** `cliente_id`, `situacao_id`, `produtos`, `proximo_vencimento`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "periodicidade": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "observacoes": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" }, "movimenta_estoque": { "type": "integer" } } } } } } } }, "example": { "cliente_id": "59104", "situacao_id": "536172", "data": "2026-09-03", "proximo_vencimento": "2026-10-03", "periodicidade": "1 month", "gerar_recebimento": "1 month", "observacoes": "Locação API a4e17f editada", "valor_produtos": "50.00", "valor_total": "50.00", "produtos": [ { "produto": { "produto_id": "41800", "nome_produto": "Produto API", "quantidade": "1.00", "valor_venda": "50.00", "valor_total": "50.00", "movimenta_estoque": 0 } } ] } } } } }, "delete": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Deletar locações e empréstimos", "operationId": "contratos_locacoes_deletar", "x-modulo": "contratos", "x-recurso": "locacoes", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Locação removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/locacoes/{id}/alterar_situacao": { "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Alterar a situação de locações e empréstimos", "operationId": "contratos_locacoes_alterar_situacao", "x-modulo": "contratos", "x-recurso": "locacoes", "x-operacao": "alterar_situacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "data_entrega": { "type": "string" }, "hora_entrega": { "type": "string" }, "data_retirada": { "type": "string" }, "hora_retirada": { "type": "string" }, "valor_frete_retirada": { "type": "string" }, "retirada_cep": { "type": "string" }, "retirada_logradouro": { "type": "string" }, "retirada_numero": { "type": "string" }, "retirada_complemento": { "type": "string" }, "retirada_bairro": { "type": "string" }, "retirada_cidade_id": { "type": "string" }, "retirada_nome_cidade": { "type": "string" }, "retirada_estado": { "type": "string" }, "vigencia_locacao": { "type": "string" }, "tipo_periodo_locacao": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto": { "type": "object", "properties": { "produto_id": { "type": "string" }, "nome_produto": { "type": "string" }, "detalhes": { "type": "string" }, "possui_variacao": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "931", "codigo": "94", "tipo": "LO", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "", "nome_canal_venda": "", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-03", "situacao_id": "536175", "nome_situacao": "Cancelado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "", "nome_plano_conta": "", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "periodicidade": "1 month", "dia_vencimento": "3", "proximo_vencimento": "2026-10-03", "gerar_recebimento": "1 month", "limite": "2", "limite_data": "", "limite_vezes": "3", "valor_produtos": "50.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "50.00", "observacoes": "Locação API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:43", "modificado_em": "2026-09-08 17:08:44", "data_entrega": "2026-09-04", "hora_entrega": "08:00:00", "data_retirada": "2026-09-20", "hora_retirada": "18:00:00", "valor_frete_retirada": "", "retirada_cep": "", "retirada_logradouro": "", "retirada_numero": "", "retirada_complemento": "", "retirada_bairro": "", "retirada_cidade_id": "", "retirada_nome_cidade": "", "retirada_estado": "", "vigencia_locacao": "", "tipo_periodo_locacao": "", "produtos": [ { "produto": { "produto_id": "41800", "nome_produto": "cigarro", "detalhes": "", "possui_variacao": "0", "quantidade": "1.00", "valor_venda": "50.00", "valor_total": "50.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "email" ], "description": "Troca a situação e registra a mudança no histórico do contrato (contratos_situacoes). O `situacao_id` tem de ser do catálogo do tipo e da empresa do token — situação de outro tipo é 400. `observacao` é opcional e vai para a linha do histórico. A resposta é o contrato já com a nova situação.\n\nSituação que lança dispara os mesmos efeitos da tela (financeiro, estoque, geração de fatura, assinatura digital e e-mail de cobrança), conforme o que estiver marcado na situação.\n\n**Campos obrigatórios:** `situacao_id`\n\n**Efeito fora do sistema:** envia e-mail a terceiros. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "observacao": { "type": "string" } } }, "example": { "situacao_id": "536175", "observacao": "Alterada pela API a4e17f" } } } } } }, "/situacoes_locacoes": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar situações de locações e empréstimos", "operationId": "contratos_situacoes_locacoes_listar", "x-modulo": "contratos", "x-recurso": "situacoes_locacoes", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string; casa por trecho do nome (LIKE)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "string" }, "padrao": { "type": "string" }, "tipo_lancamento": { "type": "string" }, "lancar_nfse": { "type": "string" }, "gerar_assinatura": { "type": "string" }, "enviar_cobranca_email": { "type": "string" }, "exibir_listagem": { "type": "string" }, "exibir_cobranca": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 4, "total_paginas": 1, "total_registros_pagina": 4, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "536172", "nome": "Em aberto", "tipo": "LO", "cor": "#999999", "ordem": "1", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536173", "nome": "Ativo", "tipo": "LO", "cor": "#5cb85c", "ordem": "2", "padrao": "1", "tipo_lancamento": "1", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536174", "nome": "Finalizado", "tipo": "LO", "cor": "#3c8dbc", "ordem": "3", "padrao": "2", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536175", "nome": "Cancelado", "tipo": "LO", "cor": "#d9534f", "ordem": "4", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Situações são cadastradas por empresa (não há lista fixa): pegue aqui o `id` para o filtro situacao_id e responda pelo `nome`. `exibir_listagem` = 0: os registros nessa situação somem da listagem quando ela não é filtrada por situação. `tipo_lancamento` diz onde está o produto e se gera fatura (ver tabela); é ele, não o nome da situação, que diz se o produto está com o cliente. Serve para /locacoes (LO e EM).", "description": "Catálogo de situações do tipo LO. É a fonte do `situacao_id` aceito no cadastro, na edição e no alterar_situacao de /api/locacoes e /api/contratos (tipos LO e EM) — situação de outro tipo ou de outra empresa é 400. Também é a fonte do filtro `situacao_id` da listagem.\n\n**`tipo_lancamento`** (coluna `lancar`) em locação e empréstimo — combina onde o produto está com o faturamento, por isso são quatro valores e não dois\n\n| valor | significado |\n|---|---|\n| 0 | produto na empresa e não gera faturas |\n| 1 | produto no cliente e gera faturas |\n| 2 | produto no cliente e não gera faturas |\n| 3 | produto na empresa e gera faturas |\n\nEscopado pela empresa do token — o catálogo de uma empresa nunca aparece para outra, e um id de outra empresa responde 404.\n\nOs enums saem com o **valor literal do banco**; a tradução está aqui, não na resposta.\n\n**Campos comuns a qualquer situação**\n\n| campo | valor | significado |\n|---|---|---|\n| `padrao` | 0 | não utilizar como padrão |\n| | 1 | padrão de inicialização (a situação que o cadastro assume) |\n| | 2 | padrão de finalização |\n| `lancar_nfse` | 0 | não gerar NFS-e |\n| | 1 | gerar NFS-e sem emitir |\n| | 2 | gerar e emitir NFS-e |\n| `gerar_assinatura` | 0 | não gerar assinatura digital |\n| | 1 | gerar assinatura digital |\n| `enviar_cobranca_email` | 0 | não enviar e-mail |\n| | 1 | enviar impressão em PDF |\n| | 2 | enviar link de cobrança |\n| `exibir_listagem` | 0 / 1 | some da listagem quando não filtrada por situação / aparece |\n| `exibir_cobranca` | 0 / 1 | não aparece / aparece na área de cobrança do cliente |\n\n`cor` é hexadecimal (`#5cb85c`) e `ordem` é a posição na tela.\n\nExige a mesma permissão da tela correspondente (GestaoLocacoes); sem ela a resposta é 403.\n\n⚠️ **Mudança de comportamento** (PRD-162): até a versão anterior estes dois endereços devolviam as situações de TODOS os tipos de contrato da empresa, inclusive as sem tipo. Agora cada um devolve só o catálogo do seu tipo, e a coluna `tipo` passou a sair no payload. Quem filtrava a lista no cliente pode remover o filtro; quem dependia de receber os outros tipos precisa chamar também /situacoes_locacoes ou /situacoes_assinaturas.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/assinaturas": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar assinaturas", "operationId": "contratos_assinaturas_listar", "x-modulo": "contratos", "x-recurso": "assinaturas", "x-operacao": "listar", "parameters": [ { "name": "codigo", "in": "query", "required": false, "description": "int — número da assinatura. NÃO ignora o período: sem datas só acha assinatura com próximo vencimento no mês atual", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "Parte do nome do cliente ou do plano", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — id do cliente", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — parte do nome, razão social ou nome social do cliente", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int; aceita lista. Situação de outra empresa ou de outro tipo é 400 — ids em `/situacoes_assinaturas`", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "canal-venda", "in": "query", "required": false, "description": "int — id do canal de venda (com hífen: `canal_venda_id` é ignorado nesta listagem)", "schema": { "type": "string" } }, { "name": "plano", "in": "query", "required": false, "description": "int — id do plano (`plano_id` é ignorado nesta listagem)", "schema": { "type": "string" } }, { "name": "detalhes", "in": "query", "required": false, "description": "string — parte do texto de detalhes de um item da assinatura", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — próximo vencimento a partir de; pode vir sozinha", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string (AAAA-MM-DD) — próximo vencimento até; pode vir sozinha", "schema": { "type": "string" } }, { "name": "atributo", "in": "query", "required": false, "description": "atributo[]=valor — assinaturas com aquele valor no campo extra — ids em `/atributos_contratos`", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 9, "total_paginas": 1, "total_registros_pagina": 9, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "710", "codigo": "44", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-01", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:44:06", "modificado_em": "2026-09-01 15:44:06", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "834", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "709", "codigo": "43", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-01", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:42:12", "modificado_em": "2026-09-01 15:42:12", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "833", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "708", "codigo": "42", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-01", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:40:43", "modificado_em": "2026-09-01 15:40:43", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "832", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "707", "codigo": "41", "tipo": "SR", "cliente_id": "59123", "nome_cliente": "vampeta", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-01", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-09-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 15:39:01", "modificado_em": "2026-09-01 15:39:01", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "831", "servico_id": "41782", "nome_servico": "serviço comissao", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "702", "codigo": "37", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 16:19:08", "modificado_em": "2026-08-04 16:19:08", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "826", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "701", "codigo": "36", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131523", "nome_vendedor": "comissao ultima parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 16:17:41", "modificado_em": "2026-08-04 16:17:41", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "825", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "700", "codigo": "35", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131522", "nome_vendedor": "comissao 1 parcela", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 15:49:07", "modificado_em": "2026-08-04 15:49:07", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "824", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "699", "codigo": "34", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131521", "nome_vendedor": "comissao integral", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "periodicidade": "1 month", "dia_vencimento": "4", "proximo_vencimento": "2026-09-04", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 15:46:06", "modificado_em": "2026-08-04 15:46:06", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "823", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] }, { "id": "698", "codigo": "33", "tipo": "SR", "cliente_id": "59119", "nome_cliente": "nova regra", "vendedor_id": "131521", "nome_vendedor": "comissao integral", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-08-04", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649404", "nome_forma_pagamento": "Cartao 10%", "periodicidade": "1 month", "dia_vencimento": "5", "proximo_vencimento": "2026-09-05", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "100.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "100.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-08-04 15:45:07", "modificado_em": "2026-08-04 15:45:07", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "822", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "100.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "100.00" } } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-periodo": { "data": "o próximo vencimento da assinatura (`proximo_vencimento`), não a data de cadastro", "padrao": "mês atual", "teto_meses": 0 }, "x-ia": "Assinaturas linha a linha. Sem datas vem só o que tem PRÓXIMO VENCIMENTO no mês atual — não é a data de cadastro (`data`): \"quantas assinaturas ativas\" sem datas esconde as que vencem em outros meses; mande o período largo (ex.: 2000-01-01 a 2030-12-31) e filtre a situação. A busca por `codigo` NÃO ignora o período: mande datas largas junto. Sem situacao_id ficam de fora as assinaturas em situação com exibir_listagem = 0. `valor_total` é o valor de cada fatura (uma por `periodicidade`): não é receita mensal nem recebido; `situacao_financeiro` fica 0 em assinatura (a fatura nasce pela recorrência). A API não informa se a fatura foi enviada ou visualizada por e-mail. Para total e quantidade de assinaturas que vencem num período use relatorio_servicos_recorrentes, já somado; nunca some as linhas.", "description": "Assinaturas / serviços recorrentes (tipo SR). Só este tipo expõe o plano vinculado (plano_id e nome_plano). Os itens vão em `servicos`.\n\nSem data_inicio/data_fim a listagem fica no mês corrente. data_inicio/data_fim filtram o PRÓXIMO VENCIMENTO (`proximo_vencimento`), não a data de cadastro — é a mesma listagem da tela Assinaturas (ServicoRecorrenteComponent::index). A página inteira é carregada num find só — o custo em consultas não cresce com o número de linhas. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram o próximo vencimento da assinatura (`proximo_vencimento`), não a data de cadastro. Sem elas: mês atual. Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Cadastrar assinaturas", "operationId": "contratos_assinaturas_cadastrar", "x-modulo": "contratos", "x-recurso": "assinaturas", "x-operacao": "cadastrar", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "932", "codigo": "223", "tipo": "SR", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-03", "situacao_id": "536179", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "periodicidade": "1 month", "dia_vencimento": "3", "proximo_vencimento": "2026-10-03", "gerar_recebimento": "1 month", "limite": "1", "limite_data": "2027-09-03", "limite_vezes": "", "valor_produtos": "99.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "99.00", "observacoes": "Assinatura API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:50", "modificado_em": "2026-09-08 17:08:50", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1181", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "99.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "99.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "`cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Exige ao menos um item em `servicos`. `limite` = 1 encerra por data e exige `limite_data`; `limite` = 2 encerra por repetições e exige `limite_vezes`. `codigo` é opcional: sem ele o nº sai da numeração da loja. Nº repetido é 400, a menos que a empresa permita duplicar (empresas_configuracoes.permitir_duplicar_codigo). Com o header `Idempotency-Key` o nº repetido deixa de ser erro: a resposta é o contrato que já existe com aquele nº, e nenhum segundo é criado. A numeração é a mesma do contrato de serviço, então um nº usado por um CO também é conflito. Não são aceitos: os campos de entrega e retirada da locação, `nota_fiscal_servico_id` e `produtos`. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro. `proximo_vencimento` é obrigatório em assinatura: o sistema deriva o `dia_vencimento` a partir dele. `periodicidade` é validada contra o catálogo (`1 day`, `7 days`, `15 days`, `20 days`, `1 month`, `2 months`, `3 months`, `6 months`, `1 year`): valor fora dele é 400. Não existe abreviação — a coluna é varchar e o valor vira o intervalo de um `strtotime()` no cálculo do próximo vencimento, então um valor inventado gravava calado e quebrava o faturamento depois. `gerar_recebimento` segue a mesma regra da `periodicidade` e é validada contra o catálogo (`0 day`, `1 day`, `3 days`, `5 days`, `7 days`, `10 days`, `15 days`, `21 days`, `1 month`): valor fora dele é 400. É opcional — sem ele a fatura nasce no próprio vencimento.\n\n**Campos obrigatórios:** `cliente_id`, `situacao_id`, `servicos`, `proximo_vencimento`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "periodicidade": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "integer" }, "limite_data": { "type": "string" }, "observacoes": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } }, "example": { "cliente_id": "59104", "situacao_id": "536179", "data": "2026-09-03", "proximo_vencimento": "2026-10-03", "periodicidade": "1 month", "gerar_recebimento": "1 month", "limite": 1, "limite_data": "2027-09-03", "observacoes": "Assinatura API a4e17f", "valor_produtos": "99.00", "valor_total": "99.00", "servicos": [ { "servico": { "servico_id": "41759", "nome_servico": "Serviço API", "quantidade": "1.00", "valor_venda": "99.00", "valor_total": "99.00" } } ] } } } } } }, "/assinaturas/{id}": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Visualizar assinaturas", "operationId": "contratos_assinaturas_visualizar", "x-modulo": "contratos", "x-recurso": "assinaturas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "array", "items": { "type": "object", "properties": { "anexo": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "arquivo": { "type": "string" }, "url": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "716", "codigo": "91", "tipo": "SR", "cliente_id": "59125", "nome_cliente": "assinatura", "vendedor_id": "131524", "nome_vendedor": "comissao parcial", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-01", "situacao_id": "536180", "nome_situacao": "Ativo", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "649188", "nome_forma_pagamento": "Cartão de Crédito", "periodicidade": "1 month", "dia_vencimento": "1", "proximo_vencimento": "2026-11-01", "gerar_recebimento": "5 days", "limite": "0", "limite_data": "", "limite_vezes": "", "valor_produtos": "10.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "10.00", "observacoes": "", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-01 17:22:21", "modificado_em": "2026-09-01 17:22:21", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [], "atributos": [], "anexos": [ { "anexo": { "id": "1520", "nome": "Comprovante de pagamento", "arquivo": "3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "url": "https://arquivos.exemplo.com.br/files/contratos_arquivos/1234/3f2a9c1e7b8d4a60b5e2c9d1f0a7b3e4.pdf", "nome_usuario": "Maria Souza", "cadastrado_em": "2026-09-14 10:32:05" } } ], "servicos": [ { "servico": { "id": "840", "servico_id": "41760", "nome_servico": "teste1", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "10.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "10.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "`proximo_vencimento` é o vencimento da próxima fatura e `valor_total` o valor de cada fatura; `periodicidade` diz de quanto em quanto tempo. `historico` traz cada troca de situação com data, observação e usuário. Responda a situação por `nome_situacao`.", "description": "O visualizar traz o contrato com as coleções filhas: itens, `pagamentos` (parcelas), `atributos`, `historico` (as trocas de situação registradas em contratos_situacoes) e `anexos` (contratos_arquivos). `historico` e `anexos` são só de leitura — enviá-los no cadastro ou na edição é 400. Cada anexo traz a `url` do arquivo; o envio é por `POST /api/contratos/{id}/anexos`. Isolamento por empresa: `empresa_id`, `loja_id` e `usuario_id` nunca vêm do request — saem do token e são injetados pelos Components. Id de contrato de outra empresa responde 404, nunca 403 (403 confirmaria que o id existe em outro tenant), e `situacao_id` de outra empresa é 400, não uma lista vazia.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Editar assinaturas", "operationId": "contratos_assinaturas_editar", "x-modulo": "contratos", "x-recurso": "assinaturas", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "932", "codigo": "223", "tipo": "SR", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-03", "situacao_id": "536179", "nome_situacao": "Em aberto", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "periodicidade": "1 month", "dia_vencimento": "3", "proximo_vencimento": "2026-10-03", "gerar_recebimento": "1 month", "limite": "1", "limite_data": "2028-01-01", "limite_vezes": "", "valor_produtos": "99.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "99.00", "observacoes": "Assinatura API a4e17f editada", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:50", "modificado_em": "2026-09-08 17:08:54", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536179", "nome_situacao": "Em aberto", "data": "", "observacao": "Revertida pelo agregado a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:52" } }, { "situacao": { "situacao_id": "536182", "nome_situacao": "Cancelado", "data": "", "observacao": "Alterada pela API a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:51" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1182", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "99.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "99.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "A edição substitui a assinatura inteira: mande o payload completo. `cliente_id` e `situacao_id` são obrigatórios e validados por posse: id de outra empresa é 400. A situação tem de vir do catálogo do tipo certo — situação de outro tipo é 400. `empresa_id`, `loja_id`, `usuario_id` e os nomes denormalizados vêm sempre do token, nunca do corpo. Campo que este tipo não usa é 400 nomeando o campo e o tipo — nada é ignorado em silêncio. Valores monetários entram e saem como string com ponto decimal e 2 casas, igual a /api/vendas. Toda chave estrangeira do cabeçalho é validada por posse e tem o nome resolvido pelo sistema: `cliente_id`, `situacao_id`, `vendedor_id`, `centro_custo_id`, `forma_pagamento_id`, `plano_contas_id` e `canal_venda_id` (mais `plano_id` na assinatura). Id de outra empresa é 400, e os campos `nome_*` correspondentes não precisam ser enviados. Campos só de leitura são recusados com 400 se vierem no corpo: `situacao_financeiro`, `situacao_estoque`, `cadastrado_em`, `modificado_em` e todos os `nome_*` — o nome sai sempre do id correspondente. Cada item das coleções também tem a posse validada: `produto_id`/`servico_id` de outra empresa, ou inexistente, é 400 (antes era 500), e o nome do item vem do cadastro. `proximo_vencimento` é obrigatório em assinatura: o sistema deriva o `dia_vencimento` a partir dele. `periodicidade` é validada contra o catálogo (`1 day`, `7 days`, `15 days`, `20 days`, `1 month`, `2 months`, `3 months`, `6 months`, `1 year`): valor fora dele é 400. Não existe abreviação — a coluna é varchar e o valor vira o intervalo de um `strtotime()` no cálculo do próximo vencimento, então um valor inventado gravava calado e quebrava o faturamento depois. `gerar_recebimento` segue a mesma regra da `periodicidade` e é validada contra o catálogo (`0 day`, `1 day`, `3 days`, `5 days`, `7 days`, `10 days`, `15 days`, `21 days`, `1 month`): valor fora dele é 400. É opcional — sem ele a fatura nasce no próprio vencimento.\n\n**Campos obrigatórios:** `cliente_id`, `situacao_id`, `servicos`, `proximo_vencimento`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cliente_id": { "type": "string" }, "situacao_id": { "type": "string" }, "data": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "periodicidade": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "integer" }, "limite_data": { "type": "string" }, "observacoes": { "type": "string" }, "valor_produtos": { "type": "string" }, "valor_total": { "type": "string" }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "quantidade": { "type": "string" }, "valor_venda": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } }, "example": { "cliente_id": "59104", "situacao_id": "536179", "data": "2026-09-03", "proximo_vencimento": "2026-10-03", "periodicidade": "1 month", "gerar_recebimento": "1 month", "limite": 1, "limite_data": "2028-01-01", "observacoes": "Assinatura API a4e17f editada", "valor_produtos": "99.00", "valor_total": "99.00", "servicos": [ { "servico": { "servico_id": "41759", "nome_servico": "Serviço API", "quantidade": "1.00", "valor_venda": "99.00", "valor_total": "99.00" } } ] } } } } }, "delete": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Deletar assinaturas", "operationId": "contratos_assinaturas_deletar", "x-modulo": "contratos", "x-recurso": "assinaturas", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": [] }, "error": { "type": "string" }, "message": { "type": "string" } } }, "example": { "code": 200, "status": "success", "data": [], "error": "OK", "message": "Assinatura removida com sucesso!" } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/assinaturas/{id}/alterar_situacao": { "post": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Alterar a situação de assinaturas", "operationId": "contratos_assinaturas_alterar_situacao", "x-modulo": "contratos", "x-recurso": "assinaturas", "x-operacao": "alterar_situacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": "string" }, "nome_vendedor": { "type": "string" }, "canal_venda_id": { "type": "string" }, "nome_canal_venda": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "data": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "centro_custo_id": { "type": "string" }, "nome_centro_custo": { "type": "string" }, "plano_contas_id": { "type": "string" }, "nome_plano_conta": { "type": "string" }, "condicao_pagamento": { "type": "string" }, "forma_pagamento_id": { "type": "string" }, "nome_forma_pagamento": { "type": "string" }, "periodicidade": { "type": "string" }, "dia_vencimento": { "type": "string" }, "proximo_vencimento": { "type": "string" }, "gerar_recebimento": { "type": "string" }, "limite": { "type": "string" }, "limite_data": { "type": "string" }, "limite_vezes": { "type": "string" }, "valor_produtos": { "type": "string" }, "acrescimo": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_frete": { "type": "string" }, "valor_total": { "type": "string" }, "observacoes": { "type": "string" }, "observacoes_fatura": { "type": "string" }, "situacao_financeiro": { "type": "string" }, "situacao_estoque": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "plano_id": { "type": "string" }, "nome_plano": { "type": "string" }, "pagamentos": { "type": "object", "properties": [] }, "historico": { "type": "array", "items": { "type": "object", "properties": { "situacao": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "data": { "type": "string" }, "observacao": { "type": "string" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "atributos": { "type": "object", "properties": [] }, "anexos": { "type": "object", "properties": [] }, "servicos": { "type": "array", "items": { "type": "object", "properties": { "servico": { "type": "object", "properties": { "id": { "type": "string" }, "servico_id": { "type": "string" }, "nome_servico": { "type": "string" }, "detalhes": { "type": "string" }, "quantidade": { "type": "string" }, "unidade": { "type": "string" }, "valor_venda": { "type": "string" }, "desconto_valor": { "type": "string" }, "desconto_porcentagem": { "type": "string" }, "valor_total": { "type": "string" } } } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "932", "codigo": "223", "tipo": "SR", "cliente_id": "59104", "nome_cliente": "teste", "vendedor_id": "", "nome_vendedor": "", "canal_venda_id": "229459", "nome_canal_venda": "Presencial", "loja_id": "81176", "nome_loja": "Matriz", "data": "2026-09-03", "situacao_id": "536182", "nome_situacao": "Cancelado", "centro_custo_id": "", "nome_centro_custo": "", "plano_contas_id": "12873353", "nome_plano_conta": "Prestações de serviços", "condicao_pagamento": "", "forma_pagamento_id": "", "nome_forma_pagamento": "", "periodicidade": "1 month", "dia_vencimento": "3", "proximo_vencimento": "2026-10-03", "gerar_recebimento": "1 month", "limite": "1", "limite_data": "2027-09-03", "limite_vezes": "", "valor_produtos": "99.00", "acrescimo": "", "desconto_valor": "", "desconto_porcentagem": "", "valor_frete": "", "valor_total": "99.00", "observacoes": "Assinatura API a4e17f", "observacoes_fatura": "", "situacao_financeiro": "0", "situacao_estoque": "0", "cadastrado_em": "2026-09-08 17:08:50", "modificado_em": "2026-09-08 17:08:50", "plano_id": "", "nome_plano": "", "pagamentos": [], "historico": [ { "situacao": { "situacao_id": "536182", "nome_situacao": "Cancelado", "data": "", "observacao": "Alterada pela API a4e17f", "nome_usuario": "agenda", "cadastrado_em": "2026-09-08 17:08:51" } } ], "atributos": [], "anexos": [], "servicos": [ { "servico": { "id": "1181", "servico_id": "41759", "nome_servico": "teste serviço", "detalhes": "", "quantidade": "1.00", "unidade": "", "valor_venda": "99.00", "desconto_valor": "", "desconto_porcentagem": "", "valor_total": "99.00" } } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-efeito-externo": [ "email" ], "description": "Troca a situação e registra a mudança no histórico do contrato (contratos_situacoes). O `situacao_id` tem de ser do catálogo do tipo e da empresa do token — situação de outro tipo é 400. `observacao` é opcional e vai para a linha do histórico. A resposta é o contrato já com a nova situação.\n\nSituação que lança dispara os mesmos efeitos da tela (financeiro, estoque, geração de fatura, assinatura digital e e-mail de cobrança), conforme o que estiver marcado na situação.\n\n**Campos obrigatórios:** `situacao_id`\n\n**Efeito fora do sistema:** envia e-mail a terceiros. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "observacao": { "type": "string" } } }, "example": { "situacao_id": "536182", "observacao": "Alterada pela API a4e17f" } } } } } }, "/situacoes_assinaturas": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar situações de assinaturas", "operationId": "contratos_situacoes_assinaturas_listar", "x-modulo": "contratos", "x-recurso": "situacoes_assinaturas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string; casa por trecho do nome (LIKE)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "string" }, "padrao": { "type": "string" }, "tipo_lancamento": { "type": "string" }, "lancar_nfse": { "type": "string" }, "gerar_assinatura": { "type": "string" }, "enviar_cobranca_email": { "type": "string" }, "exibir_listagem": { "type": "string" }, "exibir_cobranca": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 4, "total_paginas": 1, "total_registros_pagina": 4, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "536179", "nome": "Em aberto", "tipo": "SR", "cor": "#999999", "ordem": "1", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536180", "nome": "Ativo", "tipo": "SR", "cor": "#5cb85c", "ordem": "2", "padrao": "1", "tipo_lancamento": "1", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536181", "nome": "Finalizado", "tipo": "SR", "cor": "#3c8dbc", "ordem": "3", "padrao": "2", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536182", "nome": "Cancelado", "tipo": "SR", "cor": "#d9534f", "ordem": "4", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Situações são cadastradas por empresa (não há lista fixa): pegue aqui o `id` para o filtro situacao_id e responda pelo `nome`. `exibir_listagem` = 0: os registros nessa situação somem da listagem quando ela não é filtrada por situação. `tipo_lancamento` = 1: a situação gera faturas. Só serve para /assinaturas e contratos tipo SR.", "description": "Catálogo de situações do tipo SR. É a fonte do `situacao_id` aceito no cadastro, na edição e no alterar_situacao de /api/assinaturas e /api/contratos (tipo SR) — situação de outro tipo ou de outra empresa é 400. Também é a fonte do filtro `situacao_id` da listagem. Responde também em `/api/situacoes_servicos_recorrentes`, o nome que o ERP usa por dentro para o tipo SR.\n\n**`tipo_lancamento`** (coluna `lancar`) em assinatura\n\n| valor | significado |\n|---|---|\n| 0 | não gera faturas |\n| 1 | gera faturas |\n\nEscopado pela empresa do token — o catálogo de uma empresa nunca aparece para outra, e um id de outra empresa responde 404.\n\nOs enums saem com o **valor literal do banco**; a tradução está aqui, não na resposta.\n\n**Campos comuns a qualquer situação**\n\n| campo | valor | significado |\n|---|---|---|\n| `padrao` | 0 | não utilizar como padrão |\n| | 1 | padrão de inicialização (a situação que o cadastro assume) |\n| | 2 | padrão de finalização |\n| `lancar_nfse` | 0 | não gerar NFS-e |\n| | 1 | gerar NFS-e sem emitir |\n| | 2 | gerar e emitir NFS-e |\n| `gerar_assinatura` | 0 | não gerar assinatura digital |\n| | 1 | gerar assinatura digital |\n| `enviar_cobranca_email` | 0 | não enviar e-mail |\n| | 1 | enviar impressão em PDF |\n| | 2 | enviar link de cobrança |\n| `exibir_listagem` | 0 / 1 | some da listagem quando não filtrada por situação / aparece |\n| `exibir_cobranca` | 0 / 1 | não aparece / aparece na área de cobrança do cliente |\n\n`cor` é hexadecimal (`#5cb85c`) e `ordem` é a posição na tela.\n\nExige a mesma permissão da tela correspondente (GestaoAssinaturas); sem ela a resposta é 403.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_servicos_recorrentes": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar, pelo nome interno do ERP, as situações de assinaturas", "operationId": "contratos_situacoes_assinaturas_listar_nome_interno", "x-modulo": "contratos", "x-recurso": "situacoes_assinaturas", "x-operacao": "listar_nome_interno", "parameters": [ { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "string" }, "padrao": { "type": "string" }, "tipo_lancamento": { "type": "string" }, "lancar_nfse": { "type": "string" }, "gerar_assinatura": { "type": "string" }, "enviar_cobranca_email": { "type": "string" }, "exibir_listagem": { "type": "string" }, "exibir_cobranca": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 4, "total_paginas": 1, "total_registros_pagina": 4, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "536179", "nome": "Em aberto", "tipo": "SR", "cor": "#999999", "ordem": "1", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536180", "nome": "Ativo", "tipo": "SR", "cor": "#5cb85c", "ordem": "2", "padrao": "1", "tipo_lancamento": "1", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536181", "nome": "Finalizado", "tipo": "SR", "cor": "#3c8dbc", "ordem": "3", "padrao": "2", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" }, { "id": "536182", "nome": "Cancelado", "tipo": "SR", "cor": "#d9534f", "ordem": "4", "padrao": "0", "tipo_lancamento": "0", "lancar_nfse": "0", "gerar_assinatura": "0", "enviar_cobranca_email": "0", "exibir_listagem": "1", "exibir_cobranca": "0", "cadastrado_em": "2026-06-11 14:35:33", "modificado_em": "2026-06-11 14:35:33" } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "description": "Mesmo catálogo, mesmo controller e mesma resposta de `/situacoes_assinaturas`. O endereço existe porque o ERP chama este domínio de `servicos_recorrentes` por dentro (o tipo SR, o sub-plugin GestaoAssinaturas e a tela situacoes_servicos_recorrentes), enquanto o menu — e o recurso /api/assinaturas — dizem \"Assinaturas\". Prefira `/situacoes_assinaturas`, que acompanha o nome do recurso que consome o `situacao_id`.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_contratos": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Listar campos extras de contrato", "operationId": "contratos_atributos_contratos_listar", "x-modulo": "contratos", "x-recurso": "atributos_contratos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string; casa por trecho do nome (LIKE)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "total_paginas": { "type": "integer" }, "total_registros_pagina": { "type": "integer" }, "pagina_atual": { "type": "integer" }, "limite_por_pagina": { "type": "integer" }, "pagina_anterior": { "type": [ "string", "null" ] }, "url_anterior": { "type": [ "string", "null" ] }, "proxima_pagina": { "type": [ "string", "null" ] }, "proxima_url": { "type": [ "string", "null" ] } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "obrigatorio": { "type": "string" }, "exibir_impressao": { "type": "string" }, "ordem": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "object", "properties": [] } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 3, "total_paginas": 1, "total_registros_pagina": 3, "pagina_atual": 1, "limite_por_pagina": 20, "pagina_anterior": null, "url_anterior": null, "proxima_pagina": null, "proxima_url": null }, "data": [ { "id": "51", "nome": "Nº do processo", "tipo": "texto_simples", "obrigatorio": "1", "exibir_impressao": "1", "ordem": "1", "cadastrado_em": "2026-09-03 23:26:05", "modificado_em": "2026-09-03 23:26:05", "opcoes": [] }, { "id": "52", "nome": "Data da vistoria", "tipo": "data", "obrigatorio": "0", "exibir_impressao": "0", "ordem": "2", "cadastrado_em": "2026-09-03 23:26:05", "modificado_em": "2026-09-03 23:26:05", "opcoes": [] }, { "id": "53", "nome": "Canal de origem", "tipo": "check_list", "obrigatorio": "0", "exibir_impressao": "2", "ordem": "3", "cadastrado_em": "2026-09-03 23:26:05", "modificado_em": "2026-09-03 23:26:05", "opcoes": [ { "id": "10", "nome": "Indicação" }, { "id": "11", "nome": "Site" }, { "id": "12", "nome": "Telefone" } ] } ] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-ia": "Campos extras que a empresa criou para contratos (um catálogo só para os quatro tipos). O `id` daqui é o que vai no filtro atributo[]=valor de /contratos_servicos, /locacoes e /assinaturas, e o que identifica cada item de `atributos` no contrato.", "description": "Catálogo dos campos extras que a empresa criou em Contratos → Opções auxiliares → Campos extras. É a fonte dos `atributo_id` que o cadastro e a edição de contrato aceitam na coleção `atributos`, do mesmo jeito que os catálogos de situação são a fonte do `situacao_id`.\n\nO campo extra de contrato não é separado por tipo: o mesmo catálogo vale para contrato de serviço, locação, empréstimo e assinatura.\n\nSó de leitura — criar ou apagar campo extra muda o formulário de todos os contratos da empresa e continua sendo operação de tela.\n\nEscopado pela empresa do token; um id de outra empresa responde 404.\n\nOs enums saem com o **valor literal do banco**.\n\n| campo | valor | significado |\n|---|---|---|\n| `tipo` | `texto_simples` | texto livre |\n| | `numeros` | apenas dígitos |\n| | `data` | data |\n| | `cpf` | CPF |\n| | `cnpj` | CNPJ |\n| | `check_list` | escolhe uma das `opcoes` do próprio campo |\n| | `selecao_multipla` | escolhe várias das `opcoes`, gravadas separadas por vírgula |\n| `obrigatorio` | 0 / 1 | opcional / exigido no formulário da tela |\n| `exibir_impressao` | 0 | exibir na impressão quando preenchido |\n| | 1 | sempre exibir |\n| | 2 | nunca exibir |\n\n`opcoes` só vem preenchido em `check_list` e `selecao_multipla`; nos demais tipos é uma lista vazia. `ordem` é a posição no formulário.\n\n⚠️ `obrigatorio` vale para o formulário da tela: a API não recusa um contrato sem o campo extra marcado como obrigatório.\n\nExige a mesma permissão da tela correspondente (Contratos); sem ela a resposta é 403.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_contratos/{id}": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Visualizar campos extras de contrato", "operationId": "contratos_atributos_contratos_visualizar", "x-modulo": "contratos", "x-recurso": "atributos_contratos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "obrigatorio": { "type": "string" }, "exibir_impressao": { "type": "string" }, "ordem": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "53", "nome": "Canal de origem", "tipo": "check_list", "obrigatorio": "0", "exibir_impressao": "2", "ordem": "3", "cadastrado_em": "2026-09-03 23:26:05", "modificado_em": "2026-09-03 23:26:05", "opcoes": [ { "id": "10", "nome": "Indicação" }, { "id": "11", "nome": "Site" }, { "id": "12", "nome": "Telefone" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/comissao_contratos": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Consultar relatório de comissão de contratos", "operationId": "contratos_relatorio_comissao_contratos_listar", "x-modulo": "contratos", "x-recurso": "relatorio_comissao_contratos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (início do contrato ou data de lançamento)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "termino_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de término (com termino_fim); filtra junto com o período", "schema": { "type": "string" } }, { "name": "termino_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de término", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "CO = contrato de serviço, LO = locação, EM = empréstimo, SR = assinatura; sem ele entram todos — aceita vários: `tipo=1,2` ou `tipo[]=1&tipo[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — contratos de um cliente", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — nome, razão social ou nome social do cliente (busca parcial)", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — um vendedor", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do contrato (ids em /situacoes_contratos, /situacoes_locacoes ou /situacoes_assinaturas) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "situacao_financeira", "in": "query", "required": false, "description": "ab = parcela em aberto, at = em atraso (em aberto e vencida), pg = paga; sem ele entram todas", "schema": { "type": "string" } }, { "name": "lancado_financeiro", "in": "query", "required": false, "description": "1 = só contratos com financeiro lançado, 0 = só sem (0 ou 1)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "valor_total": { "type": "integer" }, "valor_comissao": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de início do contrato (ou a data de lançamento, quando ela cai no período)", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "valor_total": 0, "valor_comissao": 0 }, "itens": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "GestaoContratos/RelatoriosContratos/relatorio_comissao_contrato", "x-periodo": { "data": "a data de início do contrato (ou a data de lançamento, quando ela cai no período)", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "termino_inicio", "fim": "termino_fim", "data": "a data de término do contrato", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Responda por vendedor somando as linhas dele, e o total com data.totais.valor_total (valor das parcelas) e data.totais.valor_comissao. Cada linha é uma PARCELA financeira do contrato: o mesmo contrato aparece várias vezes, e contrato sem parcela gerada não aparece. A comissão é a porcentagem do cadastro do vendedor (comissao_pct) sobre o valor da parcela, paga ou não — para a comissão só do que já foi recebido, filtre situacao_financeira=pg. O período é a data de início OU a de lançamento do contrato, não o vencimento nem o pagamento da parcela. data.itens é só uma página — nunca some as páginas por conta própria.", "description": "Comissão dos vendedores sobre as parcelas financeiras de contratos, locações e assinaturas: uma linha por parcela, com vendedor, contrato, situação financeira, valor e comissão, e os totais de valor e de comissão. É a mesma regra do relatório de comissão por contrato da tela Contratos > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de início do contrato (ou a data de lançamento, quando ela cai no período). Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `termino_inicio` e `termino_fim` (AAAA-MM-DD, juntos) filtram a data de término do contrato. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `GestaoContratos/RelatoriosContratos/relatorio_comissao_contrato` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/contratos_servicos": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Consultar relatório de contratos de serviço", "operationId": "contratos_relatorio_contratos_servicos_listar", "x-modulo": "contratos", "x-recurso": "relatorio_contratos_servicos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de início do contrato)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "termino_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de término (com termino_fim); filtra junto com o período de início", "schema": { "type": "string" } }, { "name": "termino_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de término", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — contratos de um cliente", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — começo do nome do cliente gravado no contrato", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "string — nome do serviço do contrato (cada palavra precisa aparecer)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do contrato (ids em /situacoes_contratos) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — vendedor do contrato", "schema": { "type": "string" } }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "periodo2": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] }, "campos_extras": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de início do contrato", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "periodo2": { "data": "a data de término do contrato", "inicio": "2026-01-01", "fim": "2026-12-31" }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "quantidade": 0, "valor_total": 0 }, "itens": [], "campos_extras": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "GestaoContratos/RelatoriosContratos/relatorio_servicos", "x-periodo": { "data": "a data de início do contrato", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "termino_inicio", "fim": "termino_fim", "data": "a data de término do contrato", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Responda com data.totais.quantidade e data.totais.valor_total (soma do valor dos contratos da lista inteira). O período é a data de INÍCIO do contrato (data_entrega no banco): contrato sem data de início não aparece; 'contratos vigentes' não é esta pergunta — o filtro não pega contrato iniciado antes do período. Para término use termino_inicio/termino_fim. Só contratos de serviço (tipo CO): locações e assinaturas têm relatório próprio. valor_total é o valor do contrato, não o recebido. data.itens é só uma página — nunca some as linhas. Entram todas as situações, inclusive as ocultas da listagem (exibir_listagem = 0): para tirar canceladas, filtre situacao_id.", "description": "Contratos de serviço com data de início no período: cliente, início e término, serviços, situação e valor de cada contrato, com a quantidade e o valor somados. É a mesma regra do relatório de serviços da tela Contratos > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de início do contrato. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `termino_inicio` e `termino_fim` (AAAA-MM-DD, juntos) filtram a data de término do contrato. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `GestaoContratos/RelatoriosContratos/relatorio_servicos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/devolucoes_locacoes": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Consultar relatório de devolução de produtos locados", "operationId": "contratos_relatorio_devolucoes_locacoes_listar", "x-modulo": "contratos", "x-recurso": "relatorio_devolucoes_locacoes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data do recolhimento)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "LO = aluguel, EM = empréstimo; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — devoluções de um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — um produto", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do contrato (ids em /situacoes_locacoes) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] }, "campos_extras": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data do recolhimento (devolução) do produto", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "quantidade": 0 }, "itens": [], "campos_extras": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "GestaoLocacoes/RelatoriosLocacoes/relatorio_devolucao_produto", "x-periodo": { "data": "a data do recolhimento (devolução) do produto", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda com data.totais.quantidade (quantidade devolvida somada) e meta.total_registros (quantidade de recolhimentos). Cada linha é UM recolhimento: devolução parcial gera várias linhas para a mesma locação. O período é a data do recolhimento, não a da locação (data_contrato). Não há valor neste relatório: devolução de locação não é devolução de venda (/relatorios/devolucoes). data.itens é só uma página — nunca some as linhas.", "description": "Recolhimentos (devoluções) de produtos de locações e empréstimos feitos no período: locação, cliente, produto, quantidade, data e quem recolheu, com a quantidade total devolvida. É a mesma regra do relatório de devolução de produtos da tela Contratos > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do recolhimento (devolução) do produto. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `GestaoLocacoes/RelatoriosLocacoes/relatorio_devolucao_produto` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/locacoes_clientes": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Consultar relatório de locações por cliente", "operationId": "contratos_relatorio_locacoes_clientes_listar", "x-modulo": "contratos", "x-recurso": "relatorio_locacoes_clientes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (próximo vencimento)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "lancamento_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início da data de lançamento da locação (com lancamento_fim); filtra junto com o período", "schema": { "type": "string" } }, { "name": "lancamento_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim da data de lançamento", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "LO = aluguel, EM = empréstimo; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — locações de um cliente", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — começo do nome do cliente gravado na locação", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — só as linhas deste produto", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "int — vendedor da locação", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do contrato (ids em /situacoes_locacoes) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade_locacoes": { "type": "integer" }, "valor_total_locacoes": { "type": "integer" }, "quantidade_produtos": { "type": "integer" }, "quantidade_recolhida": { "type": "integer" }, "valor_total_produtos": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] }, "campos_extras": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "o próximo vencimento da locação", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "quantidade_locacoes": 0, "valor_total_locacoes": 0, "quantidade_produtos": 0, "quantidade_recolhida": 0, "valor_total_produtos": 0 }, "itens": [], "campos_extras": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "GestaoLocacoes/RelatoriosLocacoes/relatorio_locacoes_cliente", "x-periodo": { "data": "o próximo vencimento da locação", "padrao": "mês atual", "teto_meses": 12 }, "x-periodo2": { "inicio": "lancamento_inicio", "fim": "lancamento_fim", "data": "a data de lançamento da locação", "padrao": "não filtra", "teto_meses": 12 }, "x-ia": "Responda com data.totais: quantidade_locacoes (locações distintas), valor_total_locacoes (soma do valor das locações), quantidade_produtos e valor_total_produtos (soma dos produtos) e quantidade_recolhida (já devolvida). O período é o PRÓXIMO VENCIMENTO da locação; para a data em que foi feita use lancamento_inicio/lancamento_fim. Cada linha é um PRODUTO da locação: o valor_total da linha é o do produto, não o da locação, e a mesma locação se repete — conte locações por id ou use totais.quantidade_locacoes. Locação sem produto vem numa linha com nome_produto vazio. data.itens é só uma página — nunca some as linhas. Entram todas as situações, inclusive as ocultas da listagem (exibir_listagem = 0): para tirar canceladas, filtre situacao_id.", "description": "Locações e empréstimos com próximo vencimento no período, uma linha por produto locado: cliente, locação, produto, quantidade e valor, com a quantidade locada, a já recolhida e os valores somados. É a mesma regra do relatório de locações por cliente da tela Contratos > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram o próximo vencimento da locação. Sem elas: mês atual. Máximo: 12 meses.\n\n**Segundo período:** `lancamento_inicio` e `lancamento_fim` (AAAA-MM-DD, juntos) filtram a data de lançamento da locação. Sem elas: não filtra. Máximo: 12 meses.\n\n**Permissão exigida:** `GestaoLocacoes/RelatoriosLocacoes/relatorio_locacoes_cliente` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/produtos_locados": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Consultar relatório de produtos locados", "operationId": "contratos_relatorio_produtos_locados_listar", "x-modulo": "contratos", "x-recurso": "relatorio_produtos_locados", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de lançamento da locação)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "LO = aluguel, EM = empréstimo; sem ele entram os dois", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — locações de um cliente", "schema": { "type": "string" } }, { "name": "produto_id", "in": "query", "required": false, "description": "int — um produto", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do contrato (ids em /situacoes_locacoes) — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade_produtos": { "type": "integer" }, "quantidade": { "type": "integer" }, "valor_total": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de lançamento da locação", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "quantidade_produtos": 0, "quantidade": 0, "valor_total": 0 }, "itens": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "GestaoLocacoes/RelatoriosLocacoes/relatorio_produtos_locados", "x-periodo": { "data": "a data de lançamento da locação", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda 'mais locados' pela ordem de data.itens (quantidade decrescente) e os totais com data.totais (quantidade_produtos = produtos distintos, quantidade e valor_total somados da lista inteira). Só entram locações em situação que lança o estoque (a configuração da situação tira o produto do estoque); situação que não lança estoque fica de fora, mesmo que gere financeiro. Só produtos — serviço da locação não entra. contrato_id da linha é só o de uma das locações daquele produto. data.itens é só uma página — nunca some as linhas.", "description": "Produtos locados nas locações e empréstimos lançados no período, agrupados por produto (e variação): quantidade, valor total e valor médio, do mais locado para o menos. É a mesma regra do relatório de produtos locados da tela Contratos > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de lançamento da locação. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `GestaoLocacoes/RelatoriosLocacoes/relatorio_produtos_locados` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/servicos_recorrentes": { "get": { "tags": [ "Contratos, locações e assinaturas" ], "summary": "Consultar relatório de serviços recorrentes (assinaturas)", "operationId": "contratos_relatorio_servicos_recorrentes_listar", "x-modulo": "contratos", "x-recurso": "relatorio_servicos_recorrentes", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (próximo vencimento)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int — número da assinatura", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — assinaturas de um cliente", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — nome, razão social ou nome social do cliente (busca parcial)", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "string — nome do serviço da assinatura (cada palavra precisa aparecer)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do contrato (ids em /situacoes_assinaturas); sem ele entram só as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "canal_venda_id", "in": "query", "required": false, "description": "canais de venda — ids em `/canais_vendas` — aceita vários: `canal_venda_id=1,2` ou `canal_venda_id[]=1&canal_venda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int — centro de custo da assinatura", "schema": { "type": "string" } }, { "name": "plano_id", "in": "query", "required": false, "description": "int — plano da assinatura", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "valor_total": { "type": "integer" } } }, "itens": { "type": "object", "properties": [] }, "campos_extras": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "o próximo vencimento da assinatura", "inicio": "2026-09-01", "fim": "2026-09-30", "padrao": false }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 0, "pagina": 1, "limite": 2, "total_paginas": 0, "cache": true }, "data": { "totais": { "valor_total": 0 }, "itens": [], "campos_extras": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "GestaoAssinaturas/RelatoriosAssinaturas/relatorio_servicos_recorrentes", "x-periodo": { "data": "o próximo vencimento da assinatura", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Responda com data.totais.valor_total (soma do valor das assinaturas da lista inteira) e meta.total_registros (quantidade). O período é o PRÓXIMO VENCIMENTO, não a data de cadastro nem o pagamento: 'assinaturas que vencem em outubro' é este filtro; faturamento recebido é relatório do Financeiro. valor_total é o valor de UMA cobrança (por periodicidade), não o acumulado. Sem situacao_id ficam de fora as situações ocultas da listagem (ex.: canceladas). data.itens é só uma página — nunca some as linhas. campos_extras_valores traz {id do campo extra: valor}, com os nomes em data.campos_extras. Para listar assinaturas fora deste recorte use /assinaturas.", "description": "Assinaturas (serviços recorrentes) com próximo vencimento no período: cliente, serviços, periodicidade, situação e valor de cada uma, e o valor somado. É a mesma regra do relatório de serviços recorrentes da tela Contratos > Relatórios.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram o próximo vencimento da assinatura. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `GestaoAssinaturas/RelatoriosAssinaturas/relatorio_servicos_recorrentes` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/contatos": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Listar contatos", "operationId": "assinatura_digital_contatos_listar", "x-modulo": "assinatura_digital", "x-recurso": "contatos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato", "schema": { "type": "string" } }, { "name": "cpf", "in": "query", "required": false, "description": "string — CPF exato, como foi gravado", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — telefone exato, como foi gravado (com a pontuação, ex.: (31)2528-0579)", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — cadastrado a partir de", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — cadastrado até", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "int — página (padrão 1)", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "int — itens por página (padrão 20, máximo 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "telefone": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string" }, "cadastrado_em": { "type": "string" } } } }, "example": [ { "id": 1, "nome": "João da Silva", "telefone": "11999999999", "email": "joao@email.com", "cpf": "12345678900", "cadastrado_em": "01/04/2026 10:00" }, { "id": 2, "nome": "Maria Oliveira", "telefone": "11988888888", "email": "maria@email.com", "cpf": "98765432100", "cadastrado_em": "02/04/2026 09:00" } ] } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-periodo": { "data": "a data de cadastro do contato", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Contato é o signatário salvo na Assinatura Digital, não o cliente do ERP. A mesma pessoa pode ter vários contatos (um por documento enviado), com o mesmo nome e e-mail: para tudo o que uma pessoa assinou, filtre /documentos por email em vez de abrir um contato só. Telefone e CPF só casam escritos exatamente como foram gravados.", "description": "Contatos signatários cadastrados na empresa.\n\nSó os contatos da loja do usuário da chave. `meta.count` é o total da busca.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do contato. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] }, "post": { "tags": [ "Assinatura Digital" ], "summary": "Cadastrar contatos", "operationId": "assinatura_digital_contatos_cadastrar", "x-modulo": "assinatura_digital", "x-recurso": "contatos", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "telefone": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string" }, "cadastrado_em": { "type": "string" }, "cadastrado_por": { "type": "string" }, "modificado_em": { "type": "string" } } }, "example": { "id": 1, "nome": "João da Silva", "telefone": "11999999999", "email": "joao@email.com", "cpf": "12345678900", "cadastrado_em": "01/04/2026 10:00", "cadastrado_por": "Felipe Tenório", "modificado_em": "01/04/2026 10:00" } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "**Campos obrigatórios:** `nome`, `email`", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "cpf": { "type": "string" }, "email": { "type": "string" }, "telefone": { "type": "string" } } }, "example": { "nome": "João da Silva", "cpf": "123.456.789-00", "email": "joao@email.com", "telefone": "11999999999" } } } } } }, "/contatos/{id}": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Visualizar contatos", "operationId": "assinatura_digital_contatos_visualizar", "x-modulo": "assinatura_digital", "x-recurso": "contatos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "telefone": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string" }, "cadastrado_em": { "type": "string" }, "cadastrado_por": { "type": "string" }, "modificado_em": { "type": "string" } } }, "example": { "id": 1, "nome": "João da Silva", "telefone": "11999999999", "email": "joao@email.com", "cpf": "12345678900", "cadastrado_em": "01/04/2026 10:00", "cadastrado_por": "Felipe Tenório", "modificado_em": "01/04/2026 10:00" } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Contato inexistente ou de outra loja: 400 \"Você não tem permissão para acessar este registro.\"", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] }, "put": { "tags": [ "Assinatura Digital" ], "summary": "Editar contatos", "operationId": "assinatura_digital_contatos_editar", "x-modulo": "assinatura_digital", "x-recurso": "contatos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "telefone": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string" }, "cadastrado_em": { "type": "string" }, "cadastrado_por": { "type": "string" }, "modificado_em": { "type": "string" } } }, "example": { "id": 1, "nome": "João da Silva", "telefone": "11999999999", "email": "joao@email.com", "cpf": "12345678900", "cadastrado_em": "01/04/2026 10:00", "cadastrado_por": "Felipe Tenório", "modificado_em": "01/04/2026 10:00" } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "email": { "type": "string" }, "telefone": { "type": "string" } } }, "example": { "nome": "João da Silva Atualizado", "email": "novoemail@email.com", "telefone": "11977777777" } } } } }, "delete": { "tags": [ "Assinatura Digital" ], "summary": "Deletar contatos", "operationId": "assinatura_digital_contatos_deletar", "x-modulo": "assinatura_digital", "x-recurso": "contatos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/contatos/{id}/signatarios": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Listar participações como signatário contatos", "operationId": "assinatura_digital_contatos_signatarios", "x-modulo": "assinatura_digital", "x-recurso": "contatos", "x-operacao": "signatarios", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": [] } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-ia": "Lista só os documentos daquele contato (id), em todas as pastas. situacao_documento é a do documento inteiro; status_assinatura é a desta pessoa.", "description": "Documentos em que o contato aparece como signatário, com a situação de cada assinatura. Paginado; cada item traz `documento_id`, `documento`, `situacao_documento`, `expira_em`, `criado_em`, `nome`, `contato` (e-mail) e `status_assinatura`. Contato inexistente: 404.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/documentos": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Listar documentos", "operationId": "assinatura_digital_documentos_listar", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "listar", "parameters": [ { "name": "documento", "in": "query", "required": false, "description": "string — trecho do nome do documento", "schema": { "type": "string" } }, { "name": "contato", "in": "query", "required": false, "description": "string — trecho do nome de um signatário", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string — e-mail exato de um signatário", "schema": { "type": "string" } }, { "name": "cpf", "in": "query", "required": false, "description": "string — CPF exato de um signatário, como foi gravado", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string — telefone exato de um signatário, como foi gravado", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "andamento, assinado, expirado, cancelado ou recusado (o código que vem em status)", "schema": { "type": "string" } }, { "name": "pasta", "in": "query", "required": false, "description": "id da pasta ou todas; sem ele entram só os documentos que estão fora de pasta — ids em `/pastas`", "schema": { "type": "string" } }, { "name": "loja", "in": "query", "required": false, "description": "int — id da loja; sem ele só a loja do usuário da chave", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — cadastro do documento a partir de", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — cadastro do documento até", "schema": { "type": "string" } }, { "name": "data_inicio_expiracao", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — expira a partir de", "schema": { "type": "string" } }, { "name": "data_fim_expiracao", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — expira até", "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "description": "int — página (padrão 1)", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "int — itens por página (padrão 20, máximo 100)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "quantidade_assinaturas": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "expira_em": { "type": "string" }, "status": { "type": "string" } } } }, "example": [ { "id": 1, "nome": "Contrato de Prestação de Serviços", "quantidade_assinaturas": 2, "cadastrado_em": "01/04/2026 10:30", "expira_em": "01/07/2026", "status": "Aguardando assinaturas" }, { "id": 2, "nome": "Termo de Confidencialidade", "quantidade_assinaturas": 1, "cadastrado_em": "15/03/2026 08:00", "expira_em": "15/06/2026", "status": "Assinado" } ] } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-periodo": { "data": "a data de cadastro (criação) do documento", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Documento de assinatura eletrônica, não contrato nem assinatura recorrente. status vem em código (andamento = em andamento, ainda falta alguém assinar); no detalhe a situação vem por extenso. Sem pasta só entram os documentos FORA de pasta: para contar ou buscar todos, mande pasta=todas. Sem datas vem o histórico inteiro. quantidade_assinaturas conta os signatários, não as assinaturas feitas. \"De quem está pendente?\" se responde em /documentos/{id} (status_assinatura de cada signatário). Responda quantos por meta.count; data é só uma página — nunca some as linhas.", "description": "Documentos enviados para assinatura eletrônica.\n\nOrdem: do mais novo para o mais antigo. `meta.count` é o total da busca. `status` vem em código; `quantidade_assinaturas` é o número de signatários do documento. Sem a permissão `AssinaturaDigital/Documentos/liberado_usuario`, só os documentos criados pelo usuário da chave.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro (criação) do documento. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] }, "post": { "tags": [ "Assinatura Digital" ], "summary": "Cadastrar documentos", "operationId": "assinatura_digital_documentos_cadastrar", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "situacao": { "type": "string" }, "pasta": { "type": "string" }, "expira_em": { "type": "string" }, "criado_por": { "type": "string" }, "criado_em": { "type": "string" }, "qtd_assinaturas": { "type": "integer" }, "url_arquivo_original": { "type": "string" }, "url_arquivo_assinado": { "type": [ "string", "null" ] }, "signatarios": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "status_assinatura": { "type": "string" } } } }, "historico": { "type": "object", "properties": [] } } }, "example": { "nome": "Contrato de Prestação de Serviços", "situacao": "Aguardando assinaturas", "pasta": "Contratos 2026", "expira_em": "01/07/2026", "criado_por": "Felipe Tenório", "criado_em": "01/04/2026 10:30", "qtd_assinaturas": 1, "url_arquivo_original": "https://api.beteltecnologia.com/files/documentos/contrato.pdf", "url_arquivo_assinado": null, "signatarios": [ { "nome": "João da Silva", "contato": "joao@email.com", "status_assinatura": "Pendente" } ], "historico": [] } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "O arquivo vai em Base64 (data:application/pdf;base64,...). funcao: signatario | Testemunhar | Aprovar | Acusar recebimento. tipo_envio: email | sms | whatsapp. tipo_autenticacao: assinatura | selfie | token.\n\n**Campos obrigatórios:** `documento.nome`, `documento.arquivo`, `signatarios[].nome`, `signatarios[].email`", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documento": { "type": "object", "properties": { "nome": { "type": "string" }, "arquivo": { "type": "string" }, "pasta_id": { "type": "integer" }, "expira_em": { "type": "string" }, "permitir_recusar": { "type": "boolean" }, "lembrete_dias": { "type": "integer" }, "mensagem_envio": { "type": "string" } } }, "signatarios": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "email": { "type": "string" }, "telefone": { "type": "string" }, "cpf": { "type": "string" }, "funcao": { "type": "string" }, "tipo_envio": { "type": "string" }, "tipo_autenticacao": { "type": "string" } } } } } }, "example": { "documento": { "nome": "Contrato de Prestação de Serviços", "arquivo": "data:application/pdf;base64,JVBERi0xLjQ...", "pasta_id": 1, "expira_em": "01/07/2026", "permitir_recusar": true, "lembrete_dias": 3, "mensagem_envio": "Por favor, assine o documento em anexo." }, "signatarios": [ { "nome": "João da Silva", "email": "joao@email.com", "telefone": "11999999999", "cpf": "12345678900", "funcao": "signatario", "tipo_envio": "email", "tipo_autenticacao": "assinatura" } ] } } } } } }, "/documentos/{id}": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Visualizar documentos", "operationId": "assinatura_digital_documentos_visualizar", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "situacao": { "type": "string" }, "pasta": { "type": "string" }, "expira_em": { "type": "string" }, "criado_por": { "type": "string" }, "criado_em": { "type": "string" }, "qtd_assinaturas": { "type": "integer" }, "url_arquivo_original": { "type": "string" }, "url_arquivo_assinado": { "type": [ "string", "null" ] }, "signatarios": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "contato": { "type": "string" }, "status_assinatura": { "type": "string" } } } }, "historico": { "type": "array", "items": { "type": "object", "properties": { "evento": { "type": "string" }, "data_hora": { "type": "string" } } } } } }, "example": { "nome": "Contrato de Prestação de Serviços", "situacao": "Aguardando assinaturas", "pasta": "Contratos 2026", "expira_em": "01/07/2026", "criado_por": "Felipe Tenório", "criado_em": "01/04/2026 10:30", "qtd_assinaturas": 2, "url_arquivo_original": "https://api.beteltecnologia.com/files/documentos/contrato.pdf", "url_arquivo_assinado": null, "signatarios": [ { "nome": "João da Silva", "contato": "joao@email.com", "status_assinatura": "Pendente" }, { "nome": "Maria Oliveira", "contato": "maria@email.com", "status_assinatura": "Assinado" } ], "historico": [ { "evento": "Documento criado", "data_hora": "01/04/2026 10:30" }, { "evento": "Enviado para assinatura", "data_hora": "01/04/2026 10:35" } ] } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-ia": "A situação do documento e a de cada signatário são coisas diferentes: o documento fica Em andamento até todos assinarem, e cada signatário tem a sua (E-mail enviado, E-mail visualizado, Documento visualizado, Assinado, Recusado…). Para \"quem falta assinar\", liste os signatários cujo status_assinatura não é Assinado. A resposta não traz o link de assinatura de cada pessoa: não monte endereço.", "description": "`situacao` por extenso (Em andamento, Assinado, Expirado, Cancelado, Recusado). `pasta` é o nome da pasta (vazio = fora de pasta). `url_arquivo_assinado` fica vazio até o documento ser assinado. `signatarios[]` traz nome, `contato` (e-mail) e `status_assinatura`; `historico[]` traz cada evento com `data_hora`. Documento inexistente, de outra loja ou de outro usuário: 400 \"Você não tem permissão para acessar este registro.\"", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] }, "put": { "tags": [ "Assinatura Digital" ], "summary": "Editar documentos", "operationId": "assinatura_digital_documentos_editar", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "situacao": { "type": "string" }, "pasta": { "type": "string" }, "expira_em": { "type": "string" }, "criado_por": { "type": "string" }, "criado_em": { "type": "string" }, "qtd_assinaturas": { "type": "integer" }, "url_arquivo_original": { "type": "string" }, "url_arquivo_assinado": { "type": [ "string", "null" ] }, "signatarios": { "type": "object", "properties": [] }, "historico": { "type": "object", "properties": [] } } }, "example": { "nome": "Contrato Atualizado", "situacao": "Aguardando assinaturas", "pasta": "Pasta Nova", "expira_em": "30/07/2026", "criado_por": "Felipe Tenório", "criado_em": "01/04/2026 10:30", "qtd_assinaturas": 1, "url_arquivo_original": "https://api.beteltecnologia.com/files/documentos/contrato.pdf", "url_arquivo_assinado": null, "signatarios": [], "historico": [] } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "pasta_id": { "type": "integer" }, "expira_em": { "type": "string" } } }, "example": { "nome": "Contrato Atualizado", "pasta_id": 2, "expira_em": "30/07/2026" } } } } }, "delete": { "tags": [ "Assinatura Digital" ], "summary": "Deletar documentos", "operationId": "assinatura_digital_documentos_deletar", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/documentos/{id}/signatarios": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Listar signatários documentos", "operationId": "assinatura_digital_documentos_signatarios", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "signatarios", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "status": { "type": "string" } } } }, "example": [ { "nome": "João da Silva", "status": "Pendente" }, { "nome": "Maria Oliveira", "status": "Assinado" } ] } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Só `nome` e `status` (por extenso) de cada signatário. O detalhe do documento traz o mesmo com o e-mail.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/documentos/{id}/cancelar": { "post": { "tags": [ "Assinatura Digital" ], "summary": "Cancelar documentos", "operationId": "assinatura_digital_documentos_cancelar", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "cancelar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-efeito-externo": [ "email" ], "description": "Avisa por e-mail os signatários de que o documento foi cancelado. Documento já cancelado não pode ser cancelado de novo.\n\n**Efeito fora do sistema:** envia e-mail a terceiros. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/documentos/{id}/enviar": { "post": { "tags": [ "Assinatura Digital" ], "summary": "Reenviar para assinatura documentos", "operationId": "assinatura_digital_documentos_enviar", "x-modulo": "assinatura_digital", "x-recurso": "documentos", "x-operacao": "enviar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-efeito-externo": [ "email" ], "description": "Reenvia por e-mail a todos os signatários pendentes. Documento já assinado não pode ser reenviado.\n\n**Efeito fora do sistema:** envia e-mail a terceiros. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/modelos": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Listar modelos", "operationId": "assinatura_digital_modelos_listar", "x-modulo": "assinatura_digital", "x-recurso": "modelos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome do modelo", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "ativo": { "type": "boolean" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } }, "example": [ { "id": 1, "nome": "Contrato Padrão", "ativo": true, "cadastrado_em": "01/01/2026 08:00", "modificado_em": "01/01/2026 08:00" }, { "id": 2, "nome": "Termo de Uso", "ativo": true, "cadastrado_em": "10/01/2026 09:00", "modificado_em": "10/01/2026 09:00" } ] } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Modelos de documento com campos variáveis.\n\nSó os modelos da loja do usuário da chave.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/modelos/{id}": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Visualizar modelos", "operationId": "assinatura_digital_modelos_visualizar", "x-modulo": "assinatura_digital", "x-recurso": "modelos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "ativo": { "type": "boolean" }, "conteudo": { "type": "string" }, "cadastrado_por": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "campos": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "variavel": { "type": "string" }, "tipo": { "type": "string" }, "obrigatorio": { "type": "boolean" } } } } } }, "example": { "id": 1, "nome": "Contrato Padrão", "ativo": true, "conteudo": "

Este contrato é firmado entre...

", "cadastrado_por": "Felipe Tenório", "cadastrado_em": "01/01/2026 08:00", "modificado_em": "01/01/2026 08:00", "campos": [ { "nome": "Nome do Cliente", "variavel": "nome_cliente", "tipo": "texto", "obrigatorio": true }, { "nome": "Data de Início", "variavel": "data_inicio", "tipo": "data", "obrigatorio": true } ] } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] }, "delete": { "tags": [ "Assinatura Digital" ], "summary": "Deletar modelos", "operationId": "assinatura_digital_modelos_deletar", "x-modulo": "assinatura_digital", "x-recurso": "modelos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/modelos/{id}/documento": { "post": { "tags": [ "Assinatura Digital" ], "summary": "Gerar documento pelo modelo modelos", "operationId": "assinatura_digital_modelos_gerar_documento", "x-modulo": "assinatura_digital", "x-recurso": "modelos", "x-operacao": "gerar_documento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "202": { "description": "Sucesso", "content": { "application/json": [] } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-efeito-externo": [ "email" ], "description": "tipo: link | email | preenchimento. Com email, a chave email (array) é obrigatória; com preenchimento, a chave campos.\n\n**Campos obrigatórios:** `tipo`\n\n**Efeito fora do sistema:** envia e-mail a terceiros. Não é executada pelo MCP.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo": { "type": "string" }, "campos": { "type": "array", "items": { "type": "object", "properties": { "variavel": { "type": "string" }, "valor": { "type": "string" } } } } } }, "example": { "tipo": "preenchimento", "campos": [ { "variavel": "nome_cliente", "valor": "João da Silva" }, { "variavel": "data_inicio", "valor": "01/04/2026" } ] } } } } } }, "/pastas": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Listar pastas", "operationId": "assinatura_digital_pastas_listar", "x-modulo": "assinatura_digital", "x-recurso": "pastas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome da pasta", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — pasta criada a partir de", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "DD/MM/AAAA ou AAAA-MM-DD — pasta criada até", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } }, "example": [ { "id": 1, "nome": "Contratos 2026", "parent_id": null, "cadastrado_em": "01/01/2026 08:00", "modificado_em": "01/01/2026 08:00" }, { "id": 2, "nome": "Termos", "parent_id": 1, "cadastrado_em": "05/01/2026 09:00", "modificado_em": "05/01/2026 09:00" } ] } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "x-ia": "Pasta só organiza os documentos, não muda assinatura nem prazo. Use o id no filtro pasta de /documentos.", "description": "Pastas que organizam os documentos, com controle de acesso por usuário.\n\nLista plana com pastas e subpastas: `parent_id` é a pasta-mãe (null = pasta na raiz). Só as pastas da loja do usuário da chave; quem não é master não vê as pastas restritas a outros usuários.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] }, "post": { "tags": [ "Assinatura Digital" ], "summary": "Cadastrar pastas", "operationId": "assinatura_digital_pastas_cadastrar", "x-modulo": "assinatura_digital", "x-recurso": "pastas", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "cadastrado_por": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } }, "example": { "id": 1, "nome": "Contratos 2026", "parent_id": null, "cadastrado_por": "Felipe Tenório", "cadastrado_em": "01/01/2026 08:00", "modificado_em": "01/01/2026 08:00" } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Com acesso_liberado = false a chave usuarios é obrigatória; com true, não deve ser enviada.\n\n**Campos obrigatórios:** `nome`", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "acesso_liberado": { "type": "boolean" }, "usuarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } } }, "example": { "nome": "Contratos 2026", "acesso_liberado": false, "usuarios": [ { "id": 1, "status": "ativo" }, { "id": 2, "status": "ativo" } ] } } } } } }, "/pastas/{id}": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Visualizar pastas", "operationId": "assinatura_digital_pastas_visualizar", "x-modulo": "assinatura_digital", "x-recurso": "pastas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "cadastrado_por": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } }, "example": { "id": 1, "nome": "Contratos 2026", "parent_id": null, "cadastrado_por": "Felipe Tenório", "cadastrado_em": "01/01/2026 08:00", "modificado_em": "01/01/2026 08:00" } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Pasta inexistente: 404.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] }, "put": { "tags": [ "Assinatura Digital" ], "summary": "Editar pastas", "operationId": "assinatura_digital_pastas_editar", "x-modulo": "assinatura_digital", "x-recurso": "pastas", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "parent_id": { "type": [ "string", "null" ] }, "cadastrado_por": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } }, "example": { "id": 1, "nome": "Contratos 2026", "parent_id": null, "cadastrado_por": "Felipe Tenório", "cadastrado_em": "01/01/2026 08:00", "modificado_em": "01/01/2026 08:00" } } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Mesma regra de acesso_liberado × usuarios do cadastro.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "acesso_liberado": { "type": "boolean" }, "usuarios": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } } }, "example": { "nome": "Contratos Atualizados", "acesso_liberado": false, "usuarios": [ { "id": 3, "status": "ativo" } ] } } } } }, "delete": { "tags": [ "Assinatura Digital" ], "summary": "Deletar pastas", "operationId": "assinatura_digital_pastas_deletar", "x-modulo": "assinatura_digital", "x-recurso": "pastas", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/pastas/{id}/documentos": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Documentos da pasta pastas", "operationId": "assinatura_digital_pastas_documentos", "x-modulo": "assinatura_digital", "x-recurso": "pastas", "x-operacao": "documentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "quantidade_assinaturas": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "expira_em": { "type": "string" }, "status": { "type": "string" } } } }, "example": [ { "id": 5, "nome": "Contrato Fulano", "quantidade_assinaturas": 1, "cadastrado_em": "01/04/2026 10:30", "expira_em": "01/07/2026", "status": "Aguardando assinaturas" } ] } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "description": "Só os documentos que estão direto nesta pasta (as subpastas não entram), no mesmo formato de /documentos.", "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/pastas/{id}/usuarios": { "get": { "tags": [ "Assinatura Digital" ], "summary": "Usuários com acesso pastas", "operationId": "assinatura_digital_pastas_usuarios", "x-modulo": "assinatura_digital", "x-recurso": "pastas", "x-operacao": "usuarios", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "email": { "type": "string" }, "cpf": { "type": "string" }, "master": { "type": "integer" } } } }, "example": [ { "id": 1, "nome": "Felipe Tenório", "email": "felipe@empresa.com", "cpf": "12345678900", "master": 1 }, { "id": 2, "nome": "Ana Souza", "email": "ana@empresa.com", "cpf": "98765432100", "master": 0 } ] } } }, "400": { "description": "Requisição inválida — corpo é a mensagem de erro", "content": { "application/json": { "example": "Documento não encontrado" } } }, "401": { "description": "Não autenticado" }, "403": { "description": "Sem permissão" } }, "servers": [ { "url": "https://app.api.click.app/v1/assinatura_digital" } ] } }, "/funis": { "get": { "tags": [ "CRM" ], "summary": "Listar funis", "operationId": "crm_funis_listar", "x-modulo": "crm", "x-recurso": "funis", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "Parte do nome do funil", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limit", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "sort", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": "object", "properties": { "page": { "type": "integer" }, "current": { "type": "integer" }, "count": { "type": "integer" }, "prevPage": { "type": "boolean" }, "nextPage": { "type": "boolean" }, "pageCount": { "type": "integer" }, "order": { "type": "object", "properties": { "Funil.nome": { "type": "string" } } }, "limit": { "type": "integer" }, "options": { "type": "object", "properties": [] }, "paramType": { "type": "string" }, "start": { "type": "integer" }, "end": { "type": "integer" } } }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "padrao": { "type": "boolean" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "success": true, "meta": { "page": 1, "current": 1, "count": 1, "prevPage": false, "nextPage": false, "pageCount": 1, "order": { "Funil.nome": "ASC" }, "limit": 20, "options": [], "paramType": "querystring", "start": 1, "end": 1 }, "message": "", "data": [ { "id": 3296, "empresa_id": 76262, "nome": "Funil API 262d1c", "padrao": false, "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "25/09/2026 10:16:06", "modificado_em": "25/09/2026 10:16:06" } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "x-ia": "O funil com padrao = true é o que /negocios usa quando funil_id não vem.", "description": "Funis de venda e suas etapas. Cada negócio pertence a uma etapa de um funil.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "post": { "tags": [ "CRM" ], "summary": "Cadastrar funis", "operationId": "crm_funis_cadastrar", "x-modulo": "crm", "x-recurso": "funis", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "padrao": { "type": "boolean" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "grupos_bloqueados": { "type": "object", "properties": [] }, "grupos_bloqueados_detalhes": { "type": "object", "properties": [] }, "etapas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "ordem": { "type": "integer" }, "atributos": { "type": "object", "properties": [] } } } } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 3296, "empresa_id": 76262, "nome": "Funil API 262d1c", "padrao": false, "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "25/09/2026 10:16:06", "modificado_em": "25/09/2026 10:16:06", "grupos_bloqueados": [], "grupos_bloqueados_detalhes": [], "etapas": [ { "id": 56084, "nome": "Contato", "ordem": 0, "atributos": [] }, { "id": 56085, "nome": "Proposta", "ordem": 1, "atributos": [] }, { "id": 56086, "nome": "Fechamento", "ordem": 2, "atributos": [] } ] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "`etapas` precisa ter ao menos uma etapa. `ordem` define a posição da etapa no funil.\n\n**Campos obrigatórios:** `nome`, `etapas`, `etapas[].nome`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "etapas": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "ordem": { "type": "integer" } } } } } }, "example": { "nome": "Funil API 262d1c", "etapas": [ { "nome": "Contato", "ordem": 0 }, { "nome": "Proposta", "ordem": 1 }, { "nome": "Fechamento", "ordem": 2 } ] } } } } } }, "/funis/{id}": { "get": { "tags": [ "CRM" ], "summary": "Visualizar funis", "operationId": "crm_funis_visualizar", "x-modulo": "crm", "x-recurso": "funis", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "padrao": { "type": "boolean" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "grupos_bloqueados": { "type": "object", "properties": [] }, "grupos_bloqueados_detalhes": { "type": "object", "properties": [] }, "etapas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "ordem": { "type": "integer" }, "atributos": { "type": "object", "properties": [] } } } } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 3296, "empresa_id": 76262, "nome": "Funil API 262d1c", "padrao": false, "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "25/09/2026 10:16:06", "modificado_em": "25/09/2026 10:16:06", "grupos_bloqueados": [], "grupos_bloqueados_detalhes": [], "etapas": [ { "id": 56084, "nome": "Contato", "ordem": 0, "atributos": [] }, { "id": 56085, "nome": "Proposta", "ordem": 1, "atributos": [] }, { "id": 56086, "nome": "Fechamento", "ordem": 2, "atributos": [] } ] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Traz as `etapas` do funil, na ordem, cada uma com os campos extras vinculados.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "put": { "tags": [ "CRM" ], "summary": "Editar funis", "operationId": "crm_funis_editar", "x-modulo": "crm", "x-recurso": "funis", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "padrao": { "type": "boolean" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "grupos_bloqueados": { "type": "object", "properties": [] }, "grupos_bloqueados_detalhes": { "type": "object", "properties": [] }, "etapas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "ordem": { "type": "integer" }, "atributos": { "type": "object", "properties": [] } } } } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 3296, "empresa_id": 76262, "nome": "Funil API 262d1c editado", "padrao": false, "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "25/09/2026 10:16:06", "modificado_em": "25/09/2026 10:16:10", "grupos_bloqueados": [], "grupos_bloqueados_detalhes": [], "etapas": [ { "id": 56084, "nome": "Contato", "ordem": 0, "atributos": [] }, { "id": 56085, "nome": "Proposta enviada", "ordem": 1, "atributos": [] } ] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Envie o `id` das etapas que continuam; etapa sem `id` é criada.\n\n**Campos obrigatórios:** `nome`, `etapas`, `etapas[].nome`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "etapas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "ordem": { "type": "integer" } } } } } }, "example": { "nome": "Funil API 262d1c editado", "etapas": [ { "id": 56084, "nome": "Contato", "ordem": 0 }, { "id": 56085, "nome": "Proposta enviada", "ordem": 1 } ] } } } } }, "delete": { "tags": [ "CRM" ], "summary": "Deletar funis", "operationId": "crm_funis_deletar", "x-modulo": "crm", "x-recurso": "funis", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Funil com negócios vinculados não é excluído: responde 400 com `Existem negócios vinculados a este funil, não é possível excluí-lo.`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/funis/atributos": { "get": { "tags": [ "CRM" ], "summary": "Listar campos extras das etapas de funis", "operationId": "crm_funis_atributos", "x-modulo": "crm", "x-recurso": "funis", "x-operacao": "atributos", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": [] } } }, "example": { "success": true, "meta": null, "message": "", "data": [] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/prospectos": { "get": { "tags": [ "CRM" ], "summary": "Listar prospectos", "operationId": "crm_prospectos_listar", "x-modulo": "crm", "x-recurso": "prospectos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "Parte do nome, da razão social ou do nome social", "schema": { "type": "string" } }, { "name": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = estrangeiro", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "Código do prospecto", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "CPF ou CNPJ, com ou sem pontuação", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "Telefone ou celular, com ou sem pontuação", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "E-mail exato", "schema": { "type": "string" } }, { "name": "classificacao", "in": "query", "required": false, "description": "Classificação de 1 a 5", "schema": { "type": "string" } }, { "name": "cidade", "in": "query", "required": false, "description": "ID da cidade do endereço", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "Sigla do estado do endereço", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = ativos, 0 = inativos", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "Cadastrado a partir de (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "Cadastrado até (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "data_modificado_inicio", "in": "query", "required": false, "description": "Modificado a partir de (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "data_modificado_fim", "in": "query", "required": false, "description": "Modificado até (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limit", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "sort", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": "object", "properties": { "page": { "type": "integer" }, "current": { "type": "integer" }, "count": { "type": "integer" }, "prevPage": { "type": "boolean" }, "nextPage": { "type": "boolean" }, "pageCount": { "type": "integer" }, "order": { "type": "object", "properties": { "Cliente.nome, Cliente.id": { "type": "string" } } }, "limit": { "type": "integer" }, "options": { "type": "object", "properties": { "limit": { "type": "integer" } } }, "paramType": { "type": "string" }, "start": { "type": "integer" }, "end": { "type": "integer" } } }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "codigo": { "type": "string" }, "cpf": { "type": "string" }, "nome_social": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "es_documento": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "classificacao": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "ativo": { "type": "boolean" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "email": { "type": "string" }, "loja_virtual_ativo": { "type": "boolean" }, "webdesk_ativo": { "type": "string" }, "cadastrado_em": { "type": "string" }, "nome_tipo_pessoa": { "type": "string" }, "caminho_foto": { "type": "string" }, "documento": { "type": "string" }, "telefone_celular": { "type": "string" } } } } } }, "example": { "success": true, "meta": { "page": 1, "current": 1, "count": 1, "prevPage": false, "nextPage": false, "pageCount": 1, "order": { "Cliente.nome, Cliente.id": "asc" }, "limit": 3, "options": { "limit": 3 }, "paramType": "querystring", "start": 1, "end": 1 }, "message": "", "data": [ { "id": 59141, "codigo": "22", "cpf": "", "nome_social": "", "razao_social": "123", "cnpj": "", "es_documento": "", "nome": "teste crm", "tipo": "PR", "classificacao": "", "tipo_pessoa": "PJ", "ativo": true, "telefone": "2603-1988", "celular": "3199919919991", "email": "teste@teste.com", "loja_virtual_ativo": false, "webdesk_ativo": "0", "cadastrado_em": "11/09/2026 09:33:59", "nome_tipo_pessoa": "Pessoa jurídica", "caminho_foto": "https://upload-arquivos-dev.s3-sa-east-1.amazonaws.com/img/clientes/sem-foto.png", "documento": "", "telefone_celular": "2603-1988" } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "x-periodo": { "data": "a data de cadastro do prospecto", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Prospecto é o cadastro de cliente do tipo prospecto (ainda não cliente). O id dele é o cliente_id dos negócios. Sem datas vem a base inteira; meta.count é o total.", "description": "Clientes em prospecção (cadastro de cliente do tipo prospecto). O `id` do prospecto é o `cliente_id` usado nos negócios.\n\nOrdem: nome. Data fora do formato hoje volta 400 com o erro do banco.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de cadastro do prospecto. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "post": { "tags": [ "CRM" ], "summary": "Cadastrar prospectos", "operationId": "crm_prospectos_cadastrar", "x-modulo": "crm", "x-recurso": "prospectos", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "empresa_id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "origem_id": { "type": "string" }, "nome_origem": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "sexo": { "type": "string" }, "nome_social": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "pj_isento_ins_est": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "pj_inscricao_suframa": { "type": "string" }, "tipo_contribuinte": { "type": "string" }, "responsavel": { "type": "string" }, "es_documento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "site": { "type": "string" }, "observacoes": { "type": "string" }, "limite_credito": { "type": [ "string", "null" ] }, "permitir_ultrapassar_limite_credito": { "type": "boolean" }, "codigo_reduzido": { "type": "string" }, "webdesk_email": { "type": "string" }, "webdesk_usuario": { "type": "string" }, "webdesk_login": { "type": "string" }, "webdesk_senha": { "type": "string" }, "webdesk_ativo": { "type": "string" }, "webdesk_servicos": { "type": "string" }, "webdesk_hash": { "type": "string" }, "webdesk_ultimo_acesso": { "type": "string" }, "webdesk_nome_usuario": { "type": "string" }, "webdesk_cadastrado_em": { "type": "string" }, "webdesk_modificado_em": { "type": "string" }, "email_acesso": { "type": "string" }, "loja_virtual_senha": { "type": "string" }, "loja_virtual_ativo": { "type": "boolean" }, "loja_virtual_hash": { "type": "string" }, "loja_virtual_ultimo_acesso": { "type": "string" }, "loja_virtual_cadastrado_em": { "type": "string" }, "loja_virtual_modificado_em": { "type": "string" }, "vendas": { "type": "string" }, "vendedor_id": { "type": "integer" }, "nome_vendedor": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "ativo": { "type": "boolean" }, "cliente_loja_id": { "type": "string" }, "classificacao": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "nome_tipo_pessoa": { "type": "string" }, "caminho_foto": { "type": "string" }, "documento": { "type": "string" }, "telefone_celular": { "type": "string" }, "contatos": { "type": "object", "properties": [] }, "enderecos": { "type": "object", "properties": [] }, "fotos": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] }, "arquivos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 59154, "codigo": "33", "tipo": "PR", "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "origem_id": "", "nome_origem": "", "tipo_pessoa": "PJ", "nome": "Prospecto API 262d1c", "cpf": "", "rg": "", "data_nascimento": "", "sexo": "", "nome_social": "", "razao_social": "Prospecto API 262d1c LTDA", "cnpj": "", "inscricao_estadual": "", "pj_isento_ins_est": "0", "inscricao_municipal": "", "pj_inscricao_suframa": "", "tipo_contribuinte": "", "responsavel": "", "es_documento": "", "telefone": "(31)3333-0000", "celular": "", "fax": "", "email": "prospecto.262d1c@example.com", "site": "", "observacoes": "Cadastrado pela suíte da API", "limite_credito": null, "permitir_ultrapassar_limite_credito": false, "codigo_reduzido": "", "webdesk_email": "", "webdesk_usuario": "", "webdesk_login": "", "webdesk_senha": "", "webdesk_ativo": "0", "webdesk_servicos": "", "webdesk_hash": "", "webdesk_ultimo_acesso": "", "webdesk_nome_usuario": "", "webdesk_cadastrado_em": "", "webdesk_modificado_em": "", "email_acesso": "prospecto.262d1c@example.com", "loja_virtual_senha": "", "loja_virtual_ativo": false, "loja_virtual_hash": "", "loja_virtual_ultimo_acesso": "", "loja_virtual_cadastrado_em": "", "loja_virtual_modificado_em": "", "vendas": "0", "vendedor_id": 131463, "nome_vendedor": "agenda", "usuario_id": "131463", "nome_usuario": "agenda", "ativo": true, "cliente_loja_id": "", "classificacao": "", "cadastrado_em": "25/09/2026 10:16:15", "modificado_em": "25/09/2026 10:16:15", "nome_tipo_pessoa": "Pessoa jurídica", "caminho_foto": "https://upload-arquivos-dev.s3-sa-east-1.amazonaws.com/img/clientes/sem-foto.png", "documento": "", "telefone_celular": "(31)3333-0000", "contatos": [], "enderecos": [], "fotos": [], "atributos": [], "arquivos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Pessoa física usa `cpf`, `rg`, `sexo`, `data_nascimento`; pessoa jurídica usa `cnpj`, `razao_social`, `inscricao_estadual`, `tipo_contribuinte`.\n\n**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "razao_social": { "type": "string" }, "telefone": { "type": "string" }, "email": { "type": "string" }, "observacoes": { "type": "string" } } }, "example": { "tipo_pessoa": "PJ", "nome": "Prospecto API 262d1c", "razao_social": "Prospecto API 262d1c LTDA", "telefone": "(31) 3333-0000", "email": "prospecto.262d1c@example.com", "observacoes": "Cadastrado pela suíte da API" } } } } } }, "/prospectos/{id}": { "get": { "tags": [ "CRM" ], "summary": "Visualizar prospectos", "operationId": "crm_prospectos_visualizar", "x-modulo": "crm", "x-recurso": "prospectos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "empresa_id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "origem_id": { "type": "string" }, "nome_origem": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "sexo": { "type": "string" }, "nome_social": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "pj_isento_ins_est": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "pj_inscricao_suframa": { "type": "string" }, "tipo_contribuinte": { "type": "string" }, "responsavel": { "type": "string" }, "es_documento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "site": { "type": "string" }, "observacoes": { "type": "string" }, "limite_credito": { "type": [ "string", "null" ] }, "permitir_ultrapassar_limite_credito": { "type": "boolean" }, "codigo_reduzido": { "type": "string" }, "webdesk_email": { "type": "string" }, "webdesk_usuario": { "type": "string" }, "webdesk_login": { "type": "string" }, "webdesk_senha": { "type": "string" }, "webdesk_ativo": { "type": "string" }, "webdesk_servicos": { "type": "string" }, "webdesk_hash": { "type": "string" }, "webdesk_ultimo_acesso": { "type": "string" }, "webdesk_nome_usuario": { "type": "string" }, "webdesk_cadastrado_em": { "type": "string" }, "webdesk_modificado_em": { "type": "string" }, "email_acesso": { "type": "string" }, "loja_virtual_senha": { "type": "string" }, "loja_virtual_ativo": { "type": "boolean" }, "loja_virtual_hash": { "type": "string" }, "loja_virtual_ultimo_acesso": { "type": "string" }, "loja_virtual_cadastrado_em": { "type": "string" }, "loja_virtual_modificado_em": { "type": "string" }, "vendas": { "type": "string" }, "vendedor_id": { "type": "integer" }, "nome_vendedor": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "ativo": { "type": "boolean" }, "cliente_loja_id": { "type": "string" }, "classificacao": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "nome_tipo_pessoa": { "type": "string" }, "caminho_foto": { "type": "string" }, "documento": { "type": "string" }, "telefone_celular": { "type": "string" }, "contatos": { "type": "object", "properties": [] }, "enderecos": { "type": "object", "properties": [] }, "fotos": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] }, "arquivos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 59154, "codigo": "33", "tipo": "PR", "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "origem_id": "", "nome_origem": "", "tipo_pessoa": "PJ", "nome": "Prospecto API 262d1c", "cpf": "", "rg": "", "data_nascimento": "", "sexo": "", "nome_social": "", "razao_social": "Prospecto API 262d1c LTDA", "cnpj": "", "inscricao_estadual": "", "pj_isento_ins_est": "0", "inscricao_municipal": "", "pj_inscricao_suframa": "", "tipo_contribuinte": "", "responsavel": "", "es_documento": "", "telefone": "(31)3333-0000", "celular": "", "fax": "", "email": "prospecto.262d1c@example.com", "site": "", "observacoes": "Cadastrado pela suíte da API", "limite_credito": null, "permitir_ultrapassar_limite_credito": false, "codigo_reduzido": "", "webdesk_email": "", "webdesk_usuario": "", "webdesk_login": "", "webdesk_senha": "", "webdesk_ativo": "0", "webdesk_servicos": "", "webdesk_hash": "", "webdesk_ultimo_acesso": "", "webdesk_nome_usuario": "", "webdesk_cadastrado_em": "", "webdesk_modificado_em": "", "email_acesso": "prospecto.262d1c@example.com", "loja_virtual_senha": "", "loja_virtual_ativo": false, "loja_virtual_hash": "", "loja_virtual_ultimo_acesso": "", "loja_virtual_cadastrado_em": "", "loja_virtual_modificado_em": "", "vendas": "0", "vendedor_id": 131463, "nome_vendedor": "agenda", "usuario_id": "131463", "nome_usuario": "agenda", "ativo": true, "cliente_loja_id": "", "classificacao": "", "cadastrado_em": "25/09/2026 10:16:15", "modificado_em": "25/09/2026 10:16:15", "nome_tipo_pessoa": "Pessoa jurídica", "caminho_foto": "https://upload-arquivos-dev.s3-sa-east-1.amazonaws.com/img/clientes/sem-foto.png", "documento": "", "telefone_celular": "(31)3333-0000", "contatos": [], "enderecos": [], "fotos": [], "atributos": [], "arquivos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "put": { "tags": [ "CRM" ], "summary": "Editar prospectos", "operationId": "crm_prospectos_editar", "x-modulo": "crm", "x-recurso": "prospectos", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "codigo": { "type": "string" }, "tipo": { "type": "string" }, "empresa_id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "origem_id": { "type": "string" }, "nome_origem": { "type": "string" }, "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "cpf": { "type": "string" }, "rg": { "type": "string" }, "data_nascimento": { "type": "string" }, "sexo": { "type": "string" }, "nome_social": { "type": "string" }, "razao_social": { "type": "string" }, "cnpj": { "type": "string" }, "inscricao_estadual": { "type": "string" }, "pj_isento_ins_est": { "type": "string" }, "inscricao_municipal": { "type": "string" }, "pj_inscricao_suframa": { "type": "string" }, "tipo_contribuinte": { "type": "string" }, "responsavel": { "type": "string" }, "es_documento": { "type": "string" }, "telefone": { "type": "string" }, "celular": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "site": { "type": "string" }, "observacoes": { "type": "string" }, "limite_credito": { "type": [ "string", "null" ] }, "permitir_ultrapassar_limite_credito": { "type": "boolean" }, "codigo_reduzido": { "type": "string" }, "webdesk_email": { "type": "string" }, "webdesk_usuario": { "type": "string" }, "webdesk_login": { "type": "string" }, "webdesk_senha": { "type": "string" }, "webdesk_ativo": { "type": "string" }, "webdesk_servicos": { "type": "string" }, "webdesk_hash": { "type": "string" }, "webdesk_ultimo_acesso": { "type": "string" }, "webdesk_nome_usuario": { "type": "string" }, "webdesk_cadastrado_em": { "type": "string" }, "webdesk_modificado_em": { "type": "string" }, "email_acesso": { "type": "string" }, "loja_virtual_senha": { "type": "string" }, "loja_virtual_ativo": { "type": "boolean" }, "loja_virtual_hash": { "type": "string" }, "loja_virtual_ultimo_acesso": { "type": "string" }, "loja_virtual_cadastrado_em": { "type": "string" }, "loja_virtual_modificado_em": { "type": "string" }, "vendas": { "type": "string" }, "vendedor_id": { "type": "integer" }, "nome_vendedor": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "ativo": { "type": "boolean" }, "cliente_loja_id": { "type": "string" }, "classificacao": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "nome_tipo_pessoa": { "type": "string" }, "caminho_foto": { "type": "string" }, "documento": { "type": "string" }, "telefone_celular": { "type": "string" }, "contatos": { "type": "object", "properties": [] }, "enderecos": { "type": "object", "properties": [] }, "fotos": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] }, "arquivos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 59154, "codigo": "33", "tipo": "PR", "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "origem_id": "", "nome_origem": "", "tipo_pessoa": "PJ", "nome": "Prospecto API 262d1c editado", "cpf": "", "rg": "", "data_nascimento": "", "sexo": "", "nome_social": "", "razao_social": "Prospecto API 262d1c LTDA", "cnpj": "", "inscricao_estadual": "", "pj_isento_ins_est": "0", "inscricao_municipal": "", "pj_inscricao_suframa": "", "tipo_contribuinte": "", "responsavel": "", "es_documento": "", "telefone": "(31)3333-0000", "celular": "", "fax": "", "email": "prospecto.262d1c@example.com", "site": "", "observacoes": "Cadastrado pela suíte da API", "limite_credito": null, "permitir_ultrapassar_limite_credito": false, "codigo_reduzido": "", "webdesk_email": "", "webdesk_usuario": "", "webdesk_login": "", "webdesk_senha": "", "webdesk_ativo": "0", "webdesk_servicos": "", "webdesk_hash": "", "webdesk_ultimo_acesso": "", "webdesk_nome_usuario": "", "webdesk_cadastrado_em": "", "webdesk_modificado_em": "", "email_acesso": "prospecto.262d1c@example.com", "loja_virtual_senha": "", "loja_virtual_ativo": false, "loja_virtual_hash": "", "loja_virtual_ultimo_acesso": "", "loja_virtual_cadastrado_em": "", "loja_virtual_modificado_em": "", "vendas": "0", "vendedor_id": 131463, "nome_vendedor": "agenda", "usuario_id": "131463", "nome_usuario": "agenda", "ativo": true, "cliente_loja_id": "", "classificacao": "4", "cadastrado_em": "25/09/2026 10:16:15", "modificado_em": "25/09/2026 10:16:18", "nome_tipo_pessoa": "Pessoa jurídica", "caminho_foto": "https://upload-arquivos-dev.s3-sa-east-1.amazonaws.com/img/clientes/sem-foto.png", "documento": "", "telefone_celular": "(31)3333-0000", "contatos": [], "enderecos": [], "fotos": [], "atributos": [], "arquivos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "**Campos obrigatórios:** `tipo_pessoa`, `nome`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tipo_pessoa": { "type": "string" }, "nome": { "type": "string" }, "classificacao": { "type": "integer" } } }, "example": { "tipo_pessoa": "PJ", "nome": "Prospecto API 262d1c editado", "classificacao": 4 } } } } }, "delete": { "tags": [ "CRM" ], "summary": "Deletar prospectos", "operationId": "crm_prospectos_deletar", "x-modulo": "crm", "x-recurso": "prospectos", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/negocios": { "get": { "tags": [ "CRM" ], "summary": "Listar negócios", "operationId": "crm_negocios_listar", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "listar", "parameters": [ { "name": "modo", "in": "query", "required": false, "description": "lista = paginado; kanban = o funil com as etapas e até 10 negócios por etapa. Sem `modo`, vale a visualização salva nas configurações do usuário", "schema": { "type": "string" } }, { "name": "funil_id", "in": "query", "required": false, "description": "— ids em `/funis`", "schema": { "type": "string" } }, { "name": "etapa_id", "in": "query", "required": false, "description": "ID da etapa (só no modo lista)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "— ids em `/negocios/situacoes`", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "— ids em `/prospectos`", "schema": { "type": "string" } }, { "name": "vendedor_id", "in": "query", "required": false, "description": "ID do vendedor", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "ID da loja (também aceito como loja); sem ele, só a loja do usuário da chave", "schema": { "type": "string" } }, { "name": "usuario_id", "in": "query", "required": false, "description": "ID do usuário que cadastrou o negócio", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "Parte do nome do negócio", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "Código do negócio", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "Data do negócio a partir de (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "Data do negócio até (YYYY-MM-DD)", "schema": { "type": "string" } }, { "name": "fechamento_inicio", "in": "query", "required": false, "description": "Data de fechamento a partir de (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "fechamento_fim", "in": "query", "required": false, "description": "Data de fechamento até (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "sem_atividade", "in": "query", "required": false, "description": "1 = só negócios sem histórico há mais de um mês; exige funil_id (sem ele vem vazio)", "schema": { "type": "string" } }, { "name": "nunca_trabalhados", "in": "query", "required": false, "description": "1 = só negócios sem nenhuma tarefa; exige funil_id (sem ele vem vazio)", "schema": { "type": "string" } }, { "name": "atributo[{id}]", "in": "query", "required": false, "description": "Parte do conteúdo do campo extra `{id}`", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limit", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "sort", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": "object", "properties": { "page": { "type": "integer" }, "current": { "type": "integer" }, "count": { "type": "integer" }, "prevPage": { "type": "boolean" }, "nextPage": { "type": "boolean" }, "pageCount": { "type": "integer" }, "order": { "type": "object", "properties": { "Negocio.data_ano": { "type": "string" }, "Negocio.data_mes": { "type": "string" }, "Negocio.id": { "type": "string" } } }, "limit": { "type": "integer" }, "options": { "type": "object", "properties": [] }, "paramType": { "type": "string" }, "start": { "type": "integer" }, "end": { "type": "integer" } } }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "cliente_id": { "type": "integer" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": [ "string", "null" ] }, "nome_vendedor": { "type": "string" }, "data": { "type": "string" }, "data_ano": { "type": "string" }, "data_mes": { "type": "string" }, "data_fechamento": { "type": "string" }, "data_fechamento_ano": { "type": "string" }, "data_fechamento_mes": { "type": "string" }, "observacoes": { "type": "string" }, "ordem": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_total": { "type": "integer" }, "proposta_status": { "type": "string" }, "proposta_url": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "hash": { "type": "string" }, "situacao_data": { "type": "string" }, "situacao_id": { "type": "integer" }, "nome_situacao": { "type": "string" }, "pedido_id": { "type": [ "string", "null" ] }, "previsao_entrega": { "type": "string" }, "responsavel_id": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "cliente_tipo": { "type": "string" } } } } } }, "example": { "success": true, "meta": { "page": 1, "current": 1, "count": 1, "prevPage": false, "nextPage": false, "pageCount": 1, "order": { "Negocio.data_ano": "desc", "Negocio.data_mes": "desc", "Negocio.id": "desc" }, "limit": 20, "options": [], "paramType": "querystring", "start": 1, "end": 1 }, "message": "", "data": [ { "id": 10000438, "loja_id": 81176, "nome_loja": "Matriz", "codigo": "14", "nome": "Negócio API 262d1c", "cliente_id": 59154, "nome_cliente": "Prospecto API 262d1c editado", "vendedor_id": null, "nome_vendedor": "", "data": "2026-09-25", "data_ano": "", "data_mes": "", "data_fechamento": "", "data_fechamento_ano": "", "data_fechamento_mes": "", "observacoes": "Cadastrado pela suíte da API", "ordem": 0, "valor_servicos": 0, "valor_produtos": 300, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_total": 300, "proposta_status": "0", "proposta_url": "", "usuario_id": 131463, "nome_usuario": "agenda", "hash": "W1vl5L", "situacao_data": "2026-09-25", "situacao_id": 3793, "nome_situacao": "Arquivado", "pedido_id": null, "previsao_entrega": "", "responsavel_id": null, "cadastrado_em": "2026-09-25 10:16:32", "modificado_em": "25/09/2026 10:16:32", "cliente_tipo": "PR" } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "x-periodo": { "data": "a data do negócio", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Negócio é oportunidade do CRM, não venda do ERP (pedido_id aponta a venda gerada, quando há). Sem situacao_id só entram os negócios da situação padrão (Ativo na conta de teste): ganhos, perdidos e arquivados ficam de fora — para todos, situacao_id=0; para os ganhos, o id de Ganho em /negocios/situacoes. Sem funil_id só o funil padrão: com mais de um funil, consulte /funis e diga de qual falou. Para contar ou somar use modo=lista (meta.count é o total; data é só uma página — nunca some as linhas); o kanban corta em 10 negócios por etapa e não serve para contar. Sem datas vem o histórico inteiro.", "description": "Oportunidades de venda, cada uma numa etapa de um funil, com produtos, campos extras e arquivos.\n\nSem `funil_id`, os dois modos usam o funil padrão. `data_inicio`/`data_fim` aceitam YYYY-MM-DD ou DD/MM/YYYY; outro formato é 400. Sem `situacao_id`, vale a situação padrão; `situacao_id=0` traz todas. O modo kanban não é paginado: responde o funil com `etapas[].negocios`, no máximo 10 por etapa. Sem a permissão `Crm/Negocios/liberado_usuario`, só os negócios em que o usuário da chave é o vendedor ou quem cadastrou.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do negócio. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "post": { "tags": [ "CRM" ], "summary": "Cadastrar negócios", "operationId": "crm_negocios_cadastrar", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "cliente_id": { "type": "integer" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": [ "string", "null" ] }, "nome_vendedor": { "type": "string" }, "data": { "type": "string" }, "data_ano": { "type": "string" }, "data_mes": { "type": "string" }, "data_fechamento": { "type": "string" }, "data_fechamento_ano": { "type": "string" }, "data_fechamento_mes": { "type": "string" }, "observacoes": { "type": "string" }, "etapa_id": { "type": "integer" }, "nome_etapa": { "type": "string" }, "ordem": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_total": { "type": "integer" }, "proposta_status": { "type": "string" }, "proposta_url": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "hash": { "type": "string" }, "funil_id": { "type": "integer" }, "nome_funil": { "type": "string" }, "situacao_data": { "type": "string" }, "situacao_id": { "type": "integer" }, "nome_situacao": { "type": "string" }, "pedido_id": { "type": [ "string", "null" ] }, "previsao_entrega": { "type": "string" }, "responsavel_id": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "cliente_tipo": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "produto_id": { "type": "integer" }, "estoque_id": { "type": [ "string", "null" ] }, "nome": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "boolean" }, "possui_variacao": { "type": "boolean" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "regra_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "altura": { "type": [ "string", "null" ] }, "largura": { "type": [ "string", "null" ] }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": [ "string", "null" ] }, "valor_total": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } }, "arquivos": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 10000438, "loja_id": 81176, "nome_loja": "Matriz", "codigo": "14", "nome": "Negócio API 262d1c", "cliente_id": 59154, "nome_cliente": "Prospecto API 262d1c editado", "vendedor_id": null, "nome_vendedor": "", "data": "2026-09-25", "data_ano": "", "data_mes": "", "data_fechamento": "", "data_fechamento_ano": "", "data_fechamento_mes": "", "observacoes": "Cadastrado pela suíte da API", "etapa_id": 56084, "nome_etapa": "Contato", "ordem": 0, "valor_servicos": 0, "valor_produtos": 300, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_total": 300, "proposta_status": "0", "proposta_url": "", "usuario_id": 131463, "nome_usuario": "agenda", "hash": "W1vl5L", "funil_id": 3296, "nome_funil": "Funil API 262d1c editado", "situacao_data": "2026-09-25", "situacao_id": 3793, "nome_situacao": "Arquivado", "pedido_id": null, "previsao_entrega": "", "responsavel_id": null, "cadastrado_em": "2026-09-25 10:16:32", "modificado_em": "25/09/2026 10:16:32", "cliente_tipo": "PR", "produtos": [ { "id": 41850, "produto_id": 41843, "estoque_id": null, "nome": "Parafuso sextavado M10 (teste cotacao)", "detalhes": "", "movimenta_estoque": true, "possui_variacao": false, "sigla_unidade": "UND", "quantidade": 2, "tipo_valor_id": null, "regra_id": "", "nome_tipo_valor": "", "valor_custo": null, "valor_venda": 150, "altura": null, "largura": null, "tipo_desconto": "R$", "desconto_valor": 0, "desconto_porcentagem": null, "valor_total": 300, "cadastrado_em": "2026-09-25 10:16:32", "modificado_em": "2026-09-25 10:16:32" } ], "arquivos": [], "atributos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "O funil sai da etapa. `data` no formato YYYY-MM-DD. Em cada produto, envie também `sigla_unidade`, `altura` e `largura` (null quando não se aplica) — entram no cálculo do total para unidade M². `arquivos` recebe os ids devolvidos por `POST /negocios/upload`.\n\n**Campos obrigatórios:** `nome`, `cliente_id`, `etapa_id`, `situacao_id`, `produtos`, `produtos[].produto_id`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "cliente_id": { "type": "integer" }, "data": { "type": "string" }, "etapa_id": { "type": "integer" }, "situacao_id": { "type": "integer" }, "observacoes": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "sigla_unidade": { "type": "string" }, "altura": { "type": [ "string", "null" ] }, "largura": { "type": [ "string", "null" ] }, "quantidade": { "type": "integer" }, "valor_venda": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "valor_total": { "type": "integer" } } } } } }, "example": { "nome": "Negócio API 262d1c", "cliente_id": 59154, "data": "2026-09-25", "etapa_id": 56084, "situacao_id": 3793, "observacoes": "Cadastrado pela suíte da API", "produtos": [ { "produto_id": "41843", "sigla_unidade": "UND", "altura": null, "largura": null, "quantidade": 2, "valor_venda": 150, "desconto_valor": 0, "valor_total": 300 } ] } } } } } }, "/negocios/{id}": { "get": { "tags": [ "CRM" ], "summary": "Visualizar negócios", "operationId": "crm_negocios_visualizar", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "cliente_id": { "type": "integer" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": [ "string", "null" ] }, "nome_vendedor": { "type": "string" }, "data": { "type": "string" }, "data_ano": { "type": "string" }, "data_mes": { "type": "string" }, "data_fechamento": { "type": "string" }, "data_fechamento_ano": { "type": "string" }, "data_fechamento_mes": { "type": "string" }, "observacoes": { "type": "string" }, "etapa_id": { "type": "integer" }, "nome_etapa": { "type": "string" }, "ordem": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_total": { "type": "integer" }, "proposta_status": { "type": "string" }, "proposta_url": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "hash": { "type": "string" }, "funil_id": { "type": "integer" }, "nome_funil": { "type": "string" }, "situacao_data": { "type": "string" }, "situacao_id": { "type": "integer" }, "nome_situacao": { "type": "string" }, "pedido_id": { "type": [ "string", "null" ] }, "previsao_entrega": { "type": "string" }, "responsavel_id": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "cliente_tipo": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "produto_id": { "type": "integer" }, "estoque_id": { "type": [ "string", "null" ] }, "nome": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "boolean" }, "possui_variacao": { "type": "boolean" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "regra_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "altura": { "type": [ "string", "null" ] }, "largura": { "type": [ "string", "null" ] }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": [ "string", "null" ] }, "valor_total": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } }, "arquivos": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 10000438, "loja_id": 81176, "nome_loja": "Matriz", "codigo": "14", "nome": "Negócio API 262d1c", "cliente_id": 59154, "nome_cliente": "Prospecto API 262d1c editado", "vendedor_id": null, "nome_vendedor": "", "data": "2026-09-25", "data_ano": "", "data_mes": "", "data_fechamento": "", "data_fechamento_ano": "", "data_fechamento_mes": "", "observacoes": "Cadastrado pela suíte da API", "etapa_id": 56084, "nome_etapa": "Contato", "ordem": 0, "valor_servicos": 0, "valor_produtos": 300, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_total": 300, "proposta_status": "0", "proposta_url": "", "usuario_id": 131463, "nome_usuario": "agenda", "hash": "W1vl5L", "funil_id": 3296, "nome_funil": "Funil API 262d1c editado", "situacao_data": "2026-09-25", "situacao_id": 3793, "nome_situacao": "Arquivado", "pedido_id": null, "previsao_entrega": "", "responsavel_id": null, "cadastrado_em": "2026-09-25 10:16:32", "modificado_em": "25/09/2026 10:16:32", "cliente_tipo": "PR", "produtos": [ { "id": 41850, "produto_id": 41843, "estoque_id": null, "nome": "Parafuso sextavado M10 (teste cotacao)", "detalhes": "", "movimenta_estoque": true, "possui_variacao": false, "sigla_unidade": "UND", "quantidade": 2, "tipo_valor_id": null, "regra_id": "", "nome_tipo_valor": "", "valor_custo": null, "valor_venda": 150, "altura": null, "largura": null, "tipo_desconto": "R$", "desconto_valor": 0, "desconto_porcentagem": null, "valor_total": 300, "cadastrado_em": "2026-09-25 10:16:32", "modificado_em": "2026-09-25 10:16:32" } ], "arquivos": [], "atributos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "put": { "tags": [ "CRM" ], "summary": "Editar negócios", "operationId": "crm_negocios_editar", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "cliente_id": { "type": "integer" }, "nome_cliente": { "type": "string" }, "vendedor_id": { "type": [ "string", "null" ] }, "nome_vendedor": { "type": "string" }, "data": { "type": "string" }, "data_ano": { "type": "string" }, "data_mes": { "type": "string" }, "data_fechamento": { "type": "string" }, "data_fechamento_ano": { "type": "string" }, "data_fechamento_mes": { "type": "string" }, "observacoes": { "type": "string" }, "etapa_id": { "type": "integer" }, "nome_etapa": { "type": "string" }, "ordem": { "type": "integer" }, "valor_servicos": { "type": "integer" }, "valor_produtos": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": "integer" }, "valor_total": { "type": "integer" }, "proposta_status": { "type": "string" }, "proposta_url": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "hash": { "type": "string" }, "funil_id": { "type": "integer" }, "nome_funil": { "type": "string" }, "situacao_data": { "type": "string" }, "situacao_id": { "type": "integer" }, "nome_situacao": { "type": "string" }, "pedido_id": { "type": [ "string", "null" ] }, "previsao_entrega": { "type": "string" }, "responsavel_id": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "cliente_tipo": { "type": "string" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "produto_id": { "type": "integer" }, "estoque_id": { "type": [ "string", "null" ] }, "nome": { "type": "string" }, "detalhes": { "type": "string" }, "movimenta_estoque": { "type": "boolean" }, "possui_variacao": { "type": "boolean" }, "sigla_unidade": { "type": "string" }, "quantidade": { "type": "integer" }, "tipo_valor_id": { "type": [ "string", "null" ] }, "regra_id": { "type": "string" }, "nome_tipo_valor": { "type": "string" }, "valor_custo": { "type": [ "string", "null" ] }, "valor_venda": { "type": "integer" }, "altura": { "type": [ "string", "null" ] }, "largura": { "type": [ "string", "null" ] }, "tipo_desconto": { "type": "string" }, "desconto_valor": { "type": "integer" }, "desconto_porcentagem": { "type": [ "string", "null" ] }, "valor_total": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } }, "arquivos": { "type": "object", "properties": [] }, "atributos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 10000438, "loja_id": 81176, "nome_loja": "Matriz", "codigo": "14", "nome": "Negócio API 262d1c editado", "cliente_id": 59154, "nome_cliente": "Prospecto API 262d1c editado", "vendedor_id": null, "nome_vendedor": "", "data": "2026-09-25", "data_ano": "", "data_mes": "", "data_fechamento": "", "data_fechamento_ano": "", "data_fechamento_mes": "", "observacoes": "Cadastrado pela suíte da API", "etapa_id": 56084, "nome_etapa": "Contato", "ordem": 0, "valor_servicos": 0, "valor_produtos": 450, "desconto_valor": 0, "desconto_porcentagem": 0, "valor_total": 450, "proposta_status": "0", "proposta_url": "", "usuario_id": 131463, "nome_usuario": "agenda", "hash": "W1vl5L", "funil_id": 3296, "nome_funil": "Funil API 262d1c editado", "situacao_data": "2026-09-25", "situacao_id": 3793, "nome_situacao": "Arquivado", "pedido_id": null, "previsao_entrega": "", "responsavel_id": null, "cadastrado_em": "2026-09-25 10:16:32", "modificado_em": "25/09/2026 10:16:40", "cliente_tipo": "PR", "produtos": [ { "id": 41843, "produto_id": 41843, "estoque_id": null, "nome": "Parafuso sextavado M10 (teste cotacao)", "detalhes": "", "movimenta_estoque": true, "possui_variacao": false, "sigla_unidade": "UND", "quantidade": 3, "tipo_valor_id": null, "regra_id": "", "nome_tipo_valor": "", "valor_custo": null, "valor_venda": 150, "altura": null, "largura": null, "tipo_desconto": "R$", "desconto_valor": 0, "desconto_porcentagem": null, "valor_total": 450, "cadastrado_em": "", "modificado_em": "2026-09-25 10:16:40" } ], "arquivos": [], "atributos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "A lista de `produtos` enviada substitui a atual.\n\n**Campos obrigatórios:** `nome`, `cliente_id`, `etapa_id`, `situacao_id`, `produtos`, `produtos[].produto_id`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "cliente_id": { "type": "integer" }, "data": { "type": "string" }, "etapa_id": { "type": "integer" }, "situacao_id": { "type": "integer" }, "produtos": { "type": "array", "items": { "type": "object", "properties": { "produto_id": { "type": "string" }, "sigla_unidade": { "type": "string" }, "altura": { "type": [ "string", "null" ] }, "largura": { "type": [ "string", "null" ] }, "quantidade": { "type": "integer" }, "valor_venda": { "type": "integer" }, "desconto_valor": { "type": "integer" }, "valor_total": { "type": "integer" } } } } } }, "example": { "nome": "Negócio API 262d1c editado", "cliente_id": 59154, "data": "2026-09-25", "etapa_id": 56084, "situacao_id": 3793, "produtos": [ { "produto_id": "41843", "sigla_unidade": "UND", "altura": null, "largura": null, "quantidade": 3, "valor_venda": 150, "desconto_valor": 0, "valor_total": 450 } ] } } } } }, "delete": { "tags": [ "CRM" ], "summary": "Deletar negócios", "operationId": "crm_negocios_deletar", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/negocios/upload": { "post": { "tags": [ "CRM" ], "summary": "Enviar arquivos de negócios", "operationId": "crm_negocios_upload", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "upload", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "pasta": { "type": "string" }, "arquivo": { "type": "string" }, "caminho_arquivo": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } }, "example": { "success": true, "meta": null, "message": "", "data": [ { "id": "92", "nome": "quatro.jpg", "pasta": "24", "arquivo": "0b26be8d7b20fcf8b719dd271b2eb87f.jpg", "caminho_arquivo": "http://upload-arquivos-dev.s3-sa-east-1.amazonaws.com/files/negocios_arquivos/24/0b26be8d7b20fcf8b719dd271b2eb87f.jpg", "cadastrado_em": "10/03/2026 00:47:10" } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Devolve os arquivos gravados; use os `id` no campo `arquivos` do cadastro ou da edição do negócio.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "files[]": { "type": "string", "format": "binary", "description": "Um ou mais arquivos (até 5 MB cada; jpg, png, pdf, doc, xls, csv, txt, zip, xml e afins)" } }, "required": [ "files[]" ] } } } } } }, "/negocios/{id}/atualiza_etapa": { "post": { "tags": [ "CRM" ], "summary": "Alterar etapa de negócios", "operationId": "crm_negocios_atualiza_etapa", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "atualiza_etapa", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "string" } } }, "example": { "success": true, "meta": null, "message": "", "data": "Negócio atualizado com sucesso." } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "`funil_id` e `nome_funil` são opcionais (padrão: os do negócio).\n\n**Campos obrigatórios:** `etapa_id`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "etapa_id": { "type": "integer" } } }, "example": { "etapa_id": 56085 } } } } } }, "/negocios/{etapa_id}/atualiza_ordem": { "post": { "tags": [ "CRM" ], "summary": "Reordenar na etapa os negócios", "operationId": "crm_negocios_atualiza_ordem", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "atualiza_ordem", "parameters": [ { "name": "etapa_id", "in": "path", "required": true, "description": "ID da etapa em que o negócio está", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "string" } } }, "example": { "success": true, "meta": null, "message": "", "data": "Negócios atualizados com sucesso!" } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Na URL vai o id da **etapa**, não o do negócio. No corpo, `id` é o negócio a mover e `posicao` a nova posição dele na etapa (0 = primeiro); os demais negócios ativos da etapa são renumerados.\n\n**Campos obrigatórios:** `id`, `posicao`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "posicao": { "type": "integer" } } }, "example": { "id": 10000438, "posicao": 0 } } } } } }, "/negocios/situacoes": { "get": { "tags": [ "CRM" ], "summary": "Listar situações de negócios", "operationId": "crm_negocios_situacoes", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "situacoes", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" }, "cor": { "type": "string" } } } } } }, "example": { "success": true, "meta": null, "message": "", "data": [ { "id": 3793, "nome": "Arquivado", "cor": "#999999" }, { "id": 3794, "nome": "Ativo", "cor": "#00c0ef" }, { "id": 3795, "nome": "Perdido", "cor": "#f56954" }, { "id": 3796, "nome": "Ganho", "cor": "#5cb85c" } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/negocios/atributos": { "get": { "tags": [ "CRM" ], "summary": "Listar campos extras de negócios", "operationId": "crm_negocios_atributos", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "atributos", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": [] } } }, "example": { "success": true, "meta": null, "message": "", "data": [] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/negocios/configuracoes": { "get": { "tags": [ "CRM" ], "summary": "Configurações de negócios", "operationId": "crm_negocios_configuracoes", "x-modulo": "crm", "x-recurso": "negocios", "x-operacao": "configuracoes", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "configuracoes": { "type": "object", "properties": { "id": { "type": "string" }, "empresa_id": { "type": "string" }, "codigo_negocio": { "type": "string" }, "sincronizado": { "type": "boolean" }, "tarefa_tipo_id": { "type": "string" }, "tarefa_prioridade_id": { "type": "string" }, "tarefa_periodo": { "type": "string" }, "tarefa_entidade": { "type": "string" }, "negocio_converter_prospecto": { "type": "string" }, "cadastrado_em": { "type": "string" } } }, "configuracoes_usuario": { "type": "object", "properties": { "id": { "type": "string" }, "usuario_id": { "type": "string" }, "nome_usuario": { "type": "string" }, "loja_id": { "type": "string" }, "empresa_id": { "type": "string" }, "visualizacao_kanban": { "type": "string" }, "ordenacao_kanban": { "type": "string" }, "ordenacao_kanban_direcao": { "type": "string" }, "modificado_em": { "type": "string" }, "cadastrado_em": { "type": "string" } } }, "permissoes": { "type": "object", "properties": { "permissao_atualizar_situacao": { "type": "boolean" }, "permissao_gerenciar_negocio": { "type": "boolean" }, "permissao_compartilhar_whatsapp": { "type": "boolean" }, "permissao_enviar_email": { "type": "boolean" }, "permissao_cadastrar_tarefa": { "type": "boolean" } } } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "configuracoes": { "id": "83", "empresa_id": "76262", "codigo_negocio": "0", "sincronizado": true, "tarefa_tipo_id": "", "tarefa_prioridade_id": "", "tarefa_periodo": "", "tarefa_entidade": "", "negocio_converter_prospecto": "perguntar", "cadastrado_em": "11/09/2026 09:32:28" }, "configuracoes_usuario": { "id": "35", "usuario_id": "131463", "nome_usuario": "", "loja_id": "81176", "empresa_id": "76262", "visualizacao_kanban": "0", "ordenacao_kanban": "cadastrado_em", "ordenacao_kanban_direcao": "ASC", "modificado_em": "16/09/2026 10:35:09", "cadastrado_em": "11/09/2026 14:58:53" }, "permissoes": { "permissao_atualizar_situacao": true, "permissao_gerenciar_negocio": true, "permissao_compartilhar_whatsapp": true, "permissao_enviar_email": true, "permissao_cadastrar_tarefa": true } } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "`configuracoes` da empresa, `configuracoes_usuario` (modo de visualização e ordenação do kanban) e `permissoes` do usuário do token.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/tarefas": { "get": { "tags": [ "CRM" ], "summary": "Listar tarefas", "operationId": "crm_tarefas_listar", "x-modulo": "crm", "x-recurso": "tarefas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "Parte do nome da tarefa", "schema": { "type": "string" } }, { "name": "tipo_id", "in": "query", "required": false, "description": "— ids em `/tipos_tarefas`", "schema": { "type": "string" } }, { "name": "prioridade_id", "in": "query", "required": false, "description": "— ids em `/tarefas/prioridades`", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "0 = pendente, 1 = concluída", "schema": { "type": "string" } }, { "name": "responsavel_id", "in": "query", "required": false, "description": "ID do usuário responsável", "schema": { "type": "string" } }, { "name": "controller", "in": "query", "required": false, "description": "Tipo da entidade vinculada: clientes, prospectos ou negocios", "schema": { "type": "string" } }, { "name": "registro_id", "in": "query", "required": false, "description": "ID da entidade vinculada", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "ID da loja (também aceito como loja); sem ele, só a loja do usuário da chave", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "Previsão a partir de (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "Previsão até (YYYY-MM-DD ou DD/MM/YYYY)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limit", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "sort", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": "object", "properties": { "page": { "type": "integer" }, "current": { "type": "integer" }, "count": { "type": "integer" }, "prevPage": { "type": "boolean" }, "nextPage": { "type": "boolean" }, "pageCount": { "type": "integer" }, "order": { "type": "string" }, "limit": { "type": "integer" }, "options": { "type": "object", "properties": { "limit": { "type": "integer" } } }, "paramType": { "type": "string" }, "start": { "type": "integer" }, "end": { "type": "integer" } } }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "nome": { "type": "string" }, "tipo_id": { "type": "integer" }, "nome_tipo": { "type": "string" }, "icone_tipo": { "type": "string" }, "prioridade_id": { "type": "integer" }, "nome_prioridade": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "previsao_data": { "type": "string" }, "previsao_hora": { "type": "string" }, "descricao": { "type": "string" }, "situacao": { "type": "integer" }, "resultado": { "type": "string" }, "observacao_resultado": { "type": "string" }, "entidade": { "type": "string" }, "action": { "type": "string" }, "entidade_id": { "type": "integer" }, "nome_entidade": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "responsavel_id": { "type": "integer" }, "nome_responsavel": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } }, "example": { "success": true, "meta": { "page": 1, "current": 2, "count": 2, "prevPage": false, "nextPage": false, "pageCount": 1, "order": "Tarefa.previsao_data", "limit": 3, "options": { "limit": 3 }, "paramType": "querystring", "start": 1, "end": 2 }, "message": "", "data": [ { "id": 259, "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "nome": "teste crm", "tipo_id": 506, "nome_tipo": "E-mail", "icone_tipo": "fa fa-envelope", "prioridade_id": 2, "nome_prioridade": "Média", "data": "11/09/2026", "hora": "09:34:35", "previsao_data": "16/09/2026", "previsao_hora": "", "descricao": "", "situacao": 0, "resultado": "", "observacao_resultado": "", "entidade": "clientes", "action": "visualizar", "entidade_id": 59118, "nome_entidade": "josefo", "usuario_id": 131463, "nome_usuario": "agenda", "responsavel_id": 131463, "nome_responsavel": "agenda", "cadastrado_em": "11/09/2026 09:34:35", "modificado_em": "11/09/2026 09:34:35" }, { "id": 265, "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "nome": "Tarefa API 262d1c", "tipo_id": 524, "nome_tipo": "Tipo API 262d1c editado", "icone_tipo": "", "prioridade_id": 1, "nome_prioridade": "", "data": "25/09/2026", "hora": "10:16:50", "previsao_data": "25/09/2026", "previsao_hora": "10:00:00", "descricao": "Cadastrada pela suíte da API", "situacao": 0, "resultado": "", "observacao_resultado": "", "entidade": "negocios", "action": "visualizar", "entidade_id": 10000438, "nome_entidade": "Negócio API 262d1c", "usuario_id": 131463, "nome_usuario": "agenda", "responsavel_id": 131463, "nome_responsavel": "agenda", "cadastrado_em": "25/09/2026 10:16:50", "modificado_em": "25/09/2026 10:16:50" } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "x-periodo": { "data": "a data prevista da tarefa", "padrao": "histórico inteiro (sem recorte de mês)", "teto_meses": 0 }, "x-ia": "Tarefa do CRM (ligação, e-mail, reunião…) ligada a cliente, prospecto ou negócio — não é compromisso da agenda. situacao 0 = pendente, 1 = concluída; sem situacao vêm as duas. Para \"atrasadas\", situacao=0 com data_fim de ontem. Sem datas vem o histórico inteiro; meta.count é o total.", "description": "Tarefas vinculadas a um cliente, prospecto ou negócio.\n\nNa resposta a entidade vem como `entidade`/`entidade_id`, mas o **filtro** usa os nomes `controller`/`registro_id`. Sem a permissão de ver tarefas de todos, a lista traz só as do usuário do token. Ordem: data prevista. Data fora do formato hoje volta 400 com o erro do banco.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data prevista da tarefa. Sem elas: histórico inteiro (sem recorte de mês). Sem limite de período.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "post": { "tags": [ "CRM" ], "summary": "Cadastrar tarefas", "operationId": "crm_tarefas_cadastrar", "x-modulo": "crm", "x-recurso": "tarefas", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "nome": { "type": "string" }, "tipo_id": { "type": "integer" }, "nome_tipo": { "type": "string" }, "icone_tipo": { "type": "string" }, "prioridade_id": { "type": "integer" }, "nome_prioridade": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "previsao_data": { "type": "string" }, "previsao_hora": { "type": "string" }, "descricao": { "type": "string" }, "situacao": { "type": "integer" }, "resultado": { "type": "string" }, "observacao_resultado": { "type": "string" }, "entidade": { "type": "string" }, "entidade_id": { "type": "integer" }, "nome_entidade": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "responsavel_id": { "type": "integer" }, "nome_responsavel": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "tipo": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "ativo": { "type": "boolean" } } }, "prioridade": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": [ "string", "null" ] }, "nome": { "type": "string" }, "cor": { "type": "string" }, "usuario_id": { "type": [ "string", "null" ] }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } }, "arquivos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 265, "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "nome": "Tarefa API 262d1c", "tipo_id": 524, "nome_tipo": "Tipo API 262d1c editado", "icone_tipo": "", "prioridade_id": 1, "nome_prioridade": "", "data": "25/09/2026", "hora": "10:16:50", "previsao_data": "25/09/2026", "previsao_hora": "10:00:00", "descricao": "Cadastrada pela suíte da API", "situacao": 0, "resultado": "", "observacao_resultado": "", "entidade": "negocios", "entidade_id": 10000438, "nome_entidade": "Negócio API 262d1c", "usuario_id": 131463, "nome_usuario": "agenda", "responsavel_id": 131463, "nome_responsavel": "agenda", "cadastrado_em": "25/09/2026 10:16:50", "modificado_em": "25/09/2026 10:16:50", "tipo": { "id": 524, "empresa_id": 76262, "nome": "Tipo API 262d1c editado", "descricao": "Cadastrado pela suíte da API", "icone": "fa fa-phone", "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "2026-09-25 10:16:45", "modificado_em": "2026-09-25 10:16:47", "ativo": true }, "prioridade": { "id": 1, "empresa_id": null, "nome": "Baixa", "cor": "#008d4c", "usuario_id": null, "nome_usuario": "", "cadastrado_em": "2022-09-02 18:44:05", "modificado_em": "2022-12-20 14:58:44" }, "arquivos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "`previsao_data` no formato DD/MM/YYYY. `entidade`: clientes, prospectos ou negocios.\n\n**Campos obrigatórios:** `nome`, `tipo_id`, `prioridade_id`, `previsao_data`, `entidade`, `entidade_id`, `nome_entidade`, `responsavel_id`, `nome_responsavel`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo_id": { "type": "integer" }, "nome_tipo": { "type": "string" }, "prioridade_id": { "type": "integer" }, "previsao_data": { "type": "string" }, "previsao_hora": { "type": "string" }, "descricao": { "type": "string" }, "entidade": { "type": "string" }, "entidade_id": { "type": "integer" }, "nome_entidade": { "type": "string" }, "responsavel_id": { "type": "string" }, "nome_responsavel": { "type": "string" } } }, "example": { "nome": "Tarefa API 262d1c", "tipo_id": 524, "nome_tipo": "Tipo API 262d1c", "prioridade_id": 1, "previsao_data": "25/09/2026", "previsao_hora": "10:00", "descricao": "Cadastrada pela suíte da API", "entidade": "negocios", "entidade_id": 10000438, "nome_entidade": "Negócio API 262d1c", "responsavel_id": "131463", "nome_responsavel": "agenda" } } } } } }, "/tarefas/{id}": { "get": { "tags": [ "CRM" ], "summary": "Visualizar tarefas", "operationId": "crm_tarefas_visualizar", "x-modulo": "crm", "x-recurso": "tarefas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "nome": { "type": "string" }, "tipo_id": { "type": "integer" }, "nome_tipo": { "type": "string" }, "icone_tipo": { "type": "string" }, "prioridade_id": { "type": "integer" }, "nome_prioridade": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "previsao_data": { "type": "string" }, "previsao_hora": { "type": "string" }, "descricao": { "type": "string" }, "situacao": { "type": "integer" }, "resultado": { "type": "string" }, "observacao_resultado": { "type": "string" }, "entidade": { "type": "string" }, "entidade_id": { "type": "integer" }, "nome_entidade": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "responsavel_id": { "type": "integer" }, "nome_responsavel": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "tipo": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "ativo": { "type": "boolean" } } }, "prioridade": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": [ "string", "null" ] }, "nome": { "type": "string" }, "cor": { "type": "string" }, "usuario_id": { "type": [ "string", "null" ] }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } }, "arquivos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 265, "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "nome": "Tarefa API 262d1c", "tipo_id": 524, "nome_tipo": "Tipo API 262d1c editado", "icone_tipo": "", "prioridade_id": 1, "nome_prioridade": "", "data": "25/09/2026", "hora": "10:16:50", "previsao_data": "25/09/2026", "previsao_hora": "10:00:00", "descricao": "Cadastrada pela suíte da API", "situacao": 0, "resultado": "", "observacao_resultado": "", "entidade": "negocios", "entidade_id": 10000438, "nome_entidade": "Negócio API 262d1c", "usuario_id": 131463, "nome_usuario": "agenda", "responsavel_id": 131463, "nome_responsavel": "agenda", "cadastrado_em": "25/09/2026 10:16:50", "modificado_em": "25/09/2026 10:16:50", "tipo": { "id": 524, "empresa_id": 76262, "nome": "Tipo API 262d1c editado", "descricao": "Cadastrado pela suíte da API", "icone": "fa fa-phone", "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "2026-09-25 10:16:45", "modificado_em": "2026-09-25 10:16:47", "ativo": true }, "prioridade": { "id": 1, "empresa_id": null, "nome": "Baixa", "cor": "#008d4c", "usuario_id": null, "nome_usuario": "", "cadastrado_em": "2022-09-02 18:44:05", "modificado_em": "2022-12-20 14:58:44" }, "arquivos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "put": { "tags": [ "CRM" ], "summary": "Editar tarefas", "operationId": "crm_tarefas_editar", "x-modulo": "crm", "x-recurso": "tarefas", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "loja_id": { "type": "integer" }, "nome_loja": { "type": "string" }, "nome": { "type": "string" }, "tipo_id": { "type": "integer" }, "nome_tipo": { "type": "string" }, "icone_tipo": { "type": "string" }, "prioridade_id": { "type": "integer" }, "nome_prioridade": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "previsao_data": { "type": "string" }, "previsao_hora": { "type": "string" }, "descricao": { "type": "string" }, "situacao": { "type": "integer" }, "resultado": { "type": "string" }, "observacao_resultado": { "type": "string" }, "entidade": { "type": "string" }, "entidade_id": { "type": "integer" }, "nome_entidade": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "responsavel_id": { "type": "integer" }, "nome_responsavel": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "tipo": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "ativo": { "type": "boolean" } } }, "prioridade": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": [ "string", "null" ] }, "nome": { "type": "string" }, "cor": { "type": "string" }, "usuario_id": { "type": [ "string", "null" ] }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } }, "arquivos": { "type": "object", "properties": [] } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 265, "empresa_id": 76262, "loja_id": 81176, "nome_loja": "Matriz", "nome": "Tarefa API 262d1c editada", "tipo_id": 524, "nome_tipo": "Tipo API 262d1c", "icone_tipo": "", "prioridade_id": 1, "nome_prioridade": "", "data": "25/09/2026", "hora": "10:16:50", "previsao_data": "25/09/2026", "previsao_hora": "10:00:00", "descricao": "Cadastrada pela suíte da API", "situacao": 1, "resultado": "1", "observacao_resultado": "Proposta enviada", "entidade": "negocios", "entidade_id": 10000438, "nome_entidade": "Negócio API 262d1c", "usuario_id": 131463, "nome_usuario": "agenda", "responsavel_id": 131463, "nome_responsavel": "agenda", "cadastrado_em": "25/09/2026 10:16:50", "modificado_em": "25/09/2026 10:16:54", "tipo": { "id": 524, "empresa_id": 76262, "nome": "Tipo API 262d1c editado", "descricao": "Cadastrado pela suíte da API", "icone": "fa fa-phone", "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "2026-09-25 10:16:45", "modificado_em": "2026-09-25 10:16:47", "ativo": true }, "prioridade": { "id": 1, "empresa_id": null, "nome": "Baixa", "cor": "#008d4c", "usuario_id": null, "nome_usuario": "", "cadastrado_em": "2022-09-02 18:44:05", "modificado_em": "2022-12-20 14:58:44" }, "arquivos": [] } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Para concluir, envie `situacao` = 1 com `resultado` (1 = bem-sucedido, 0 = mal-sucedido) e, se quiser, o texto em `observacao_resultado`. Campo omitido, como `previsao_hora`, mantém o valor atual.\n\n**Campos obrigatórios:** `nome`, `tipo_id`, `prioridade_id`, `previsao_data`, `entidade`, `entidade_id`, `nome_entidade`, `responsavel_id`, `nome_responsavel`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "tipo_id": { "type": "integer" }, "nome_tipo": { "type": "string" }, "prioridade_id": { "type": "integer" }, "previsao_data": { "type": "string" }, "situacao": { "type": "integer" }, "resultado": { "type": "integer" }, "observacao_resultado": { "type": "string" }, "entidade": { "type": "string" }, "entidade_id": { "type": "integer" }, "nome_entidade": { "type": "string" }, "responsavel_id": { "type": "string" }, "nome_responsavel": { "type": "string" } } }, "example": { "nome": "Tarefa API 262d1c editada", "tipo_id": 524, "nome_tipo": "Tipo API 262d1c", "prioridade_id": 1, "previsao_data": "25/09/2026", "situacao": 1, "resultado": 1, "observacao_resultado": "Proposta enviada", "entidade": "negocios", "entidade_id": 10000438, "nome_entidade": "Negócio API 262d1c", "responsavel_id": "131463", "nome_responsavel": "agenda" } } } } }, "delete": { "tags": [ "CRM" ], "summary": "Deletar tarefas", "operationId": "crm_tarefas_deletar", "x-modulo": "crm", "x-recurso": "tarefas", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/tarefas/prioridades": { "get": { "tags": [ "CRM" ], "summary": "Listar prioridades de tarefas", "operationId": "crm_tarefas_prioridades", "x-modulo": "crm", "x-recurso": "tarefas", "x-operacao": "prioridades", "parameters": [], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "nome": { "type": "string" } } } } } }, "example": { "success": true, "meta": null, "message": "", "data": [ { "id": 1, "nome": "Baixa" }, { "id": 2, "nome": "Média" }, { "id": 3, "nome": "Alta" } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/tipos_tarefas": { "get": { "tags": [ "CRM" ], "summary": "Listar tipos de tarefas", "operationId": "crm_tipos_tarefas_listar", "x-modulo": "crm", "x-recurso": "tipos_tarefas", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "Parte do nome do tipo", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limit", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "sort", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": "object", "properties": { "page": { "type": "integer" }, "current": { "type": "integer" }, "count": { "type": "integer" }, "prevPage": { "type": "boolean" }, "nextPage": { "type": "boolean" }, "pageCount": { "type": "integer" }, "order": { "type": "object", "properties": { "TiposTarefa.nome": { "type": "string" } } }, "limit": { "type": "integer" }, "options": { "type": "object", "properties": { "limit": { "type": "integer" } } }, "paramType": { "type": "string" }, "start": { "type": "integer" }, "end": { "type": "integer" } } }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "ativo": { "type": "boolean" }, "cadastrado_em": { "type": "string" }, "padrao": { "type": "boolean" } } } } } }, "example": { "success": true, "meta": { "page": 1, "current": 3, "count": 6, "prevPage": false, "nextPage": true, "pageCount": 2, "order": { "TiposTarefa.nome": "asc" }, "limit": 3, "options": { "limit": 3 }, "paramType": "querystring", "start": 1, "end": 3 }, "message": "", "data": [ { "id": 506, "empresa_id": 76262, "nome": "E-mail", "descricao": "Envio de e-mail", "icone": "fa fa-envelope", "ativo": true, "cadastrado_em": "11/09/2026 09:32:27", "padrao": false }, { "id": 507, "empresa_id": 76262, "nome": "Ligação", "descricao": "Ligação com cliente", "icone": "fa fa-phone", "ativo": true, "cadastrado_em": "11/09/2026 09:32:27", "padrao": false }, { "id": 511, "empresa_id": 76262, "nome": "Nota", "descricao": "Nota importante", "icone": "fa fa-file", "ativo": true, "cadastrado_em": "11/09/2026 09:32:27", "padrao": false } ] } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "Tipos que classificam as tarefas (ligação, e-mail, reunião…). Os tipos padrão do sistema vêm com `padrao` = true.", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "post": { "tags": [ "CRM" ], "summary": "Cadastrar tipos de tarefas", "operationId": "crm_tipos_tarefas_cadastrar", "x-modulo": "crm", "x-recurso": "tipos_tarefas", "x-operacao": "cadastrar", "parameters": [], "responses": { "201": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "ativo": { "type": "boolean" }, "padrao": { "type": "boolean" } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 524, "empresa_id": 76262, "nome": "Tipo API 262d1c", "descricao": "Cadastrado pela suíte da API", "icone": "fa fa-user", "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "25/09/2026 10:16:45", "modificado_em": "25/09/2026 10:16:45", "ativo": true, "padrao": false } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "`icone` é uma classe do Font Awesome 4 (ex.: `fa fa-phone`).\n\n**Campos obrigatórios:** `nome`, `icone`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "ativo": { "type": "boolean" } } }, "example": { "nome": "Tipo API 262d1c", "descricao": "Cadastrado pela suíte da API", "icone": "fa fa-user", "ativo": true } } } } } }, "/tipos_tarefas/{id}": { "get": { "tags": [ "CRM" ], "summary": "Visualizar tipos de tarefas", "operationId": "crm_tipos_tarefas_visualizar", "x-modulo": "crm", "x-recurso": "tipos_tarefas", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "ativo": { "type": "boolean" }, "padrao": { "type": "boolean" } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 524, "empresa_id": 76262, "nome": "Tipo API 262d1c", "descricao": "Cadastrado pela suíte da API", "icone": "fa fa-user", "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "25/09/2026 10:16:45", "modificado_em": "25/09/2026 10:16:45", "ativo": true, "padrao": false } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] }, "put": { "tags": [ "CRM" ], "summary": "Editar tipos de tarefas", "operationId": "crm_tipos_tarefas_editar", "x-modulo": "crm", "x-recurso": "tipos_tarefas", "x-operacao": "editar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "meta": { "type": [ "string", "null" ] }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "integer" }, "empresa_id": { "type": "integer" }, "nome": { "type": "string" }, "descricao": { "type": "string" }, "icone": { "type": "string" }, "usuario_id": { "type": "integer" }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "ativo": { "type": "boolean" }, "padrao": { "type": "boolean" } } } } }, "example": { "success": true, "meta": null, "message": "", "data": { "id": 524, "empresa_id": 76262, "nome": "Tipo API 262d1c editado", "descricao": "Cadastrado pela suíte da API", "icone": "fa fa-phone", "usuario_id": 131463, "nome_usuario": "agenda", "cadastrado_em": "25/09/2026 10:16:45", "modificado_em": "25/09/2026 10:16:47", "ativo": true, "padrao": false } } } } }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "description": "**Campos obrigatórios:** `nome`, `icone`", "servers": [ { "url": "https://app.api.click.app/v1/crm" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nome": { "type": "string" }, "icone": { "type": "string" }, "ativo": { "type": "boolean" } } }, "example": { "nome": "Tipo API 262d1c editado", "icone": "fa fa-phone", "ativo": true } } } } }, "delete": { "tags": [ "CRM" ], "summary": "Deletar tipos de tarefas", "operationId": "crm_tipos_tarefas_deletar", "x-modulo": "crm", "x-recurso": "tipos_tarefas", "x-operacao": "deletar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "Sucesso, sem conteúdo" }, "400": { "description": "Dados inválidos ou registro não encontrado — o motivo vem em `message`", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Funil não encontrado.", "data": [] } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Access Token não informado!", "data": [] } } } }, "402": { "description": "Plano não permite integrar com API ou com o módulo", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O seu plano atual não permite integrar com CRM. Por favor, contrate outro plano!", "data": [] } } } }, "403": { "description": "Usuário sem permissão para o recurso", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "Você não tem permissão para acessar esta funcionalidade.", "data": [] } } } }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "success": false, "meta": null, "message": "O limite de requisicoes foi atingido", "data": [] } } } } }, "servers": [ { "url": "https://app.api.click.app/v1/crm" } ] } }, "/chamados": { "get": { "tags": [ "Atendimentos" ], "summary": "Listar chamados", "operationId": "atendimentos_chamados_listar", "x-modulo": "atendimentos", "x-recurso": "chamados", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de abertura do chamado)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string — número do chamado que o cliente vê (não é o id); com ele o período e a regra das situações escondidas são ignorados", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do chamado (cadastro da empresa em Atendimentos > Situações); sem ele só entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "assunto_id", "in": "query", "required": false, "description": "assuntos do chamado (Atendimentos > Assuntos) — aceita vários: `assunto_id=1,2` ou `assunto_id[]=1&assunto_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "forma_atendimento_id", "in": "query", "required": false, "description": "formas de atendimento (Atendimentos > Formas de atendimento) — aceita vários: `forma_atendimento_id=1,2` ou `forma_atendimento_id[]=1&forma_atendimento_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente (filtro exato) — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "cliente", "in": "query", "required": false, "description": "string — nome, razão social ou nome social do cliente (busca parcial)", "schema": { "type": "string" } }, { "name": "atendente_id", "in": "query", "required": false, "description": "usuários atendentes do chamado — ids em `/usuarios` — aceita vários: `atendente_id=1,2` ou `atendente_id[]=1&atendente_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "chamados": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "protocolo": { "type": "string" }, "tipo": { "type": "string" }, "visibilidade": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "assunto_id": { "type": "string" }, "nome_assunto": { "type": "string" }, "forma_atendimento_id": { "type": "string" }, "nome_forma_atendimento": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "atendente_id": { "type": "string" }, "nome_atendente": { "type": "string" }, "lido_atendente": { "type": "integer" }, "lido_cliente": { "type": "integer" }, "ultima_situacao": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } }, "por_situacao": { "type": "array", "items": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome": { "type": "string" }, "quantidade": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de abertura do chamado", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "chamados": 1 }, "itens": [ { "id": "208", "codigo": "9001", "protocolo": "TESTE-22598-1", "tipo": "R", "visibilidade": "0", "loja_id": "65", "nome_loja": "Master", "situacao_id": "304276", "nome_situacao": "Em aberto (TESTE GCK-22598)", "assunto_id": "385559", "nome_assunto": "Dúvida (TESTE GCK-22598)", "forma_atendimento_id": "303810", "nome_forma_atendimento": "Telefone (TESTE GCK-22598)", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "atendente_id": "45", "nome_atendente": "Atendente TESTE GCK-22598", "lido_atendente": 0, "lido_cliente": 0, "ultima_situacao": "2026-10-27 20:18:28", "cadastrado_em": "2026-10-02 09:30:00", "modificado_em": "2026-10-27 20:18:28" } ], "por_situacao": [ { "situacao_id": "304276", "nome": "Em aberto (TESTE GCK-22598)", "quantidade": 1 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Chamados/index", "x-periodo": { "data": "a data de abertura do chamado", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Chamado é atendimento/ticket de suporte ao cliente — não é venda, ordem de serviço nem tarefa do CRM. data.totais.chamados conta os chamados do período e data.por_situacao divide essa contagem por situação: responda com esses números e cite o período de meta.periodo. Sem situacao_id a listagem ESCONDE as situações configuradas para não aparecer na listagem (em geral as finalizadas): \"nenhum chamado\" sem situacao_id não quer dizer que não houve chamado — para contar todos, passe as situações. codigo é o número do chamado (acha o chamado em qualquer data e qualquer situação); id é o identificador interno. As mensagens e o histórico estão só em /chamados/{id}. data.itens é só uma página — nunca some as linhas.", "description": "Chamados de atendimento (tela Atendimentos > Chamados), só leitura. A listagem traz os chamados abertos no período com a contagem por situação; o detalhe traz os campos extras, o histórico de situações e as mensagens trocadas com o cliente.\n\nMesmas restrições da tela: só as lojas do usuário da chave e, sem a permissão `Atendimentos/Chamados/liberado_usuario` (Acessar de outros funcionários), só os chamados dele e os que ainda não têm atendente. Ordem: não lidos pelo atendente primeiro, depois do mais novo para o mais antigo.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de abertura do chamado. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Atendimentos/Chamados/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/chamados/{id}": { "get": { "tags": [ "Atendimentos" ], "summary": "Visualizar chamados", "operationId": "atendimentos_chamados_visualizar", "x-modulo": "atendimentos", "x-recurso": "chamados", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "protocolo": { "type": "string" }, "tipo": { "type": "string" }, "visibilidade": { "type": "string" }, "loja_id": { "type": "string" }, "nome_loja": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "assunto_id": { "type": "string" }, "nome_assunto": { "type": "string" }, "forma_atendimento_id": { "type": "string" }, "nome_forma_atendimento": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "atendente_id": { "type": "string" }, "nome_atendente": { "type": "string" }, "lido_atendente": { "type": "integer" }, "lido_cliente": { "type": "integer" }, "ultima_situacao": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "nome_tipo": { "type": "string" }, "nome_visibilidade": { "type": "string" }, "descricao": { "type": "string" }, "atributos": { "type": "object", "properties": [] }, "historico": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "observacao": { "type": "string" }, "arquivo": { "type": [ "string", "null" ] }, "nome_usuario": { "type": "string" }, "cadastrado_em": { "type": "string" } } } }, "mensagens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "autor": { "type": "string" }, "nome_usuario": { "type": "string" }, "nome_cliente": { "type": [ "string", "null" ] }, "mensagem": { "type": "string" }, "arquivo": { "type": [ "string", "null" ] }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "208", "codigo": "9001", "protocolo": "TESTE-22598-1", "tipo": "R", "visibilidade": "0", "loja_id": "65", "nome_loja": "Master", "situacao_id": "304276", "nome_situacao": "Em aberto (TESTE GCK-22598)", "assunto_id": "385559", "nome_assunto": "Dúvida (TESTE GCK-22598)", "forma_atendimento_id": "303810", "nome_forma_atendimento": "Telefone (TESTE GCK-22598)", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "atendente_id": "45", "nome_atendente": "Atendente TESTE GCK-22598", "lido_atendente": 0, "lido_cliente": 0, "ultima_situacao": "2026-10-27 20:18:28", "cadastrado_em": "2026-10-02 09:30:00", "modificado_em": "2026-10-27 20:18:28", "nome_tipo": "Receptivo", "nome_visibilidade": "Restrito: Não exibir na Área do Cliente", "descricao": "Chamado de teste da API (TESTE GCK-22598)", "atributos": [], "historico": [ { "id": "309", "situacao_id": "304276", "nome_situacao": "Em aberto (TESTE GCK-22598)", "observacao": "Chamado aberto (TESTE GCK-22598)", "arquivo": null, "nome_usuario": "Atendente TESTE GCK-22598", "cadastrado_em": "2026-10-02 09:30:00" } ], "mensagens": [ { "id": "107", "autor": "atendente", "nome_usuario": "Atendente TESTE GCK-22598", "nome_cliente": null, "mensagem": "Resposta do atendente (TESTE GCK-22598)", "arquivo": null, "cadastrado_em": "2026-10-02 10:00:00" }, { "id": "106", "autor": "cliente", "nome_usuario": null, "nome_cliente": "Cliente TESTE SR", "mensagem": "Mensagem do cliente (TESTE GCK-22598)", "arquivo": null, "cadastrado_em": "2026-10-02 09:31:00" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Chamados/visualizar", "x-ia": "404 também quando o chamado é de uma loja que o usuário da chave não acessa ou, sem Atendimentos/Chamados/liberado_usuario, de outro atendente. A situação atual é nome_situacao; o histórico mostra cada mudança com a observação de quem mudou. tipo R = receptivo (o cliente procurou), A = ativo (a empresa procurou). visibilidade 1 = aparece para o cliente na Área do Cliente.", "description": "Pela API o detalhe NÃO marca o chamado como lido pelo atendente (a tela marca). `historico` e `mensagens` vêm do mais novo para o mais antigo; `autor` diz se a mensagem é do cliente ou de um atendente; `arquivo` é o link do anexo, quando há.\n\n**Permissão exigida:** `Atendimentos/Chamados/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/assuntos_atendimentos": { "get": { "tags": [ "Atendimentos" ], "summary": "Listar assuntos de atendimento", "operationId": "atendimentos_assuntos_atendimentos_listar", "x-modulo": "atendimentos", "x-recurso": "assuntos_atendimentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome do assunto", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página (padrão e máximo 100)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 1 }, "itens": [ { "id": "385559", "nome": "Dúvida (TESTE GCK-22598)", "cadastrado_em": "2026-10-27 20:18:28" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Assuntos/index", "x-ia": "Use para traduzir o nome de um assunto no assunto_id antes de filtrar /chamados. data.totais.quantidade conta todos os assuntos da busca, não só os da página.", "description": "Assuntos que a empresa cadastrou para classificar os chamados (Atendimentos > Assuntos), só leitura. É a fonte do assunto_id que /chamados e /relatorios/chamados aceitam como filtro.\n\nCadastro da empresa: não há filtro de loja nem de período. Ordem: nome.\n\n**Permissão exigida:** `Atendimentos/Assuntos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/assuntos_atendimentos/{id}": { "get": { "tags": [ "Atendimentos" ], "summary": "Visualizar assuntos de atendimento", "operationId": "atendimentos_assuntos_atendimentos_visualizar", "x-modulo": "atendimentos", "x-recurso": "assuntos_atendimentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "385559", "nome": "Dúvida (TESTE GCK-22598)", "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Assuntos/visualizar", "description": "404 quando o assunto não existe ou é de outra empresa.\n\n**Permissão exigida:** `Atendimentos/Assuntos/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_atendimentos": { "get": { "tags": [ "Atendimentos" ], "summary": "Listar campos extras de atendimento", "operationId": "atendimentos_atributos_atendimentos_listar", "x-modulo": "atendimentos", "x-recurso": "atributos_atendimentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome do campo extra", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página (padrão e máximo 100)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "nome_tipo": { "type": "string" }, "obrigatorio": { "type": "integer" }, "exibir_area_cliente": { "type": "integer" }, "opcoes": { "type": "object", "properties": [] }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 2 }, "itens": [ { "id": "42", "nome": "Número do pedido (TESTE GCK-22721)", "tipo": "texto_simples", "nome_tipo": "Texto", "obrigatorio": 0, "exibir_area_cliente": 0, "opcoes": [], "cadastrado_em": "2026-10-29 17:35:22", "modificado_em": "2026-10-29 17:35:22" }, { "id": "41", "nome": "Prioridade (TESTE GCK-22721)", "tipo": "check_list", "nome_tipo": "Seleção única", "obrigatorio": 1, "exibir_area_cliente": 1, "opcoes": [ { "id": "16", "nome": "Alta (TESTE GCK-22721)" }, { "id": "17", "nome": "Baixa (TESTE GCK-22721)" } ], "cadastrado_em": "2026-10-29 17:35:22", "modificado_em": "2026-10-29 17:35:22" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Atributos/index", "x-ia": "Os valores que cada chamado tem nesses campos estão em /chamados/{id} (data.atributos), não aqui. data.totais.quantidade conta todos os campos extras da busca.", "description": "Campos extras que a empresa criou para os chamados (Atendimentos > Campos extras), com as opções dos campos de seleção, só leitura. É a fonte do atributo_id que aparece em data.atributos de /chamados/{id} e /relatorios/chamados.\n\nCadastro da empresa: não há filtro de loja nem de período. Ordem: nome. `tipo`: texto_simples, numeros, data, cpf, cnpj, check_list (seleção única) ou selecao_multipla; `nome_tipo` é o rótulo da tela. `opcoes` só vem preenchido nos tipos de seleção. `obrigatorio` 1 = o chamado não salva sem o campo; `exibir_area_cliente` 1 = o cliente vê e preenche o campo na Área do Cliente.\n\n**Permissão exigida:** `Atendimentos/Atributos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/atributos_atendimentos/{id}": { "get": { "tags": [ "Atendimentos" ], "summary": "Visualizar campos extras de atendimento", "operationId": "atendimentos_atributos_atendimentos_visualizar", "x-modulo": "atendimentos", "x-recurso": "atributos_atendimentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "nome_tipo": { "type": "string" }, "obrigatorio": { "type": "integer" }, "exibir_area_cliente": { "type": "integer" }, "opcoes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" } } } }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "41", "nome": "Prioridade (TESTE GCK-22721)", "tipo": "check_list", "nome_tipo": "Seleção única", "obrigatorio": 1, "exibir_area_cliente": 1, "opcoes": [ { "id": "16", "nome": "Alta (TESTE GCK-22721)" }, { "id": "17", "nome": "Baixa (TESTE GCK-22721)" } ], "cadastrado_em": "2026-10-29 17:35:22", "modificado_em": "2026-10-29 17:35:22" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Atributos/visualizar", "description": "404 quando o campo extra não existe ou é de outra empresa.\n\n**Permissão exigida:** `Atendimentos/Atributos/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/formas_atendimentos": { "get": { "tags": [ "Atendimentos" ], "summary": "Listar formas de atendimento", "operationId": "atendimentos_formas_atendimentos_listar", "x-modulo": "atendimentos", "x-recurso": "formas_atendimentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome da forma de atendimento", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página (padrão e máximo 100)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cadastrado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 1 }, "itens": [ { "id": "303810", "nome": "Telefone (TESTE GCK-22598)", "cadastrado_em": "2026-10-27 20:18:28" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Formas/index", "x-ia": "Forma de atendimento é o canal do chamado — não confunda com forma de pagamento (/formas_pagamentos). data.totais.quantidade conta todas as formas da busca, não só as da página.", "description": "Canais pelos quais o atendimento acontece (telefone, e-mail, WhatsApp…), como a empresa cadastrou em Atendimentos > Formas de atendimento, só leitura. É a fonte do forma_atendimento_id que /chamados e /relatorios/chamados aceitam como filtro.\n\nCadastro da empresa: não há filtro de loja nem de período. Ordem: nome.\n\n**Permissão exigida:** `Atendimentos/Formas/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/formas_atendimentos/{id}": { "get": { "tags": [ "Atendimentos" ], "summary": "Visualizar formas de atendimento", "operationId": "atendimentos_formas_atendimentos_visualizar", "x-modulo": "atendimentos", "x-recurso": "formas_atendimentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "303810", "nome": "Telefone (TESTE GCK-22598)", "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Formas/visualizar", "description": "404 quando a forma de atendimento não existe ou é de outra empresa.\n\n**Permissão exigida:** `Atendimentos/Formas/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/chamados": { "get": { "tags": [ "Atendimentos" ], "summary": "Consultar relatório de chamados", "operationId": "atendimentos_relatorio_chamados_listar", "x-modulo": "atendimentos", "x-recurso": "relatorio_chamados", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data de abertura do chamado)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "modo", "in": "query", "required": false, "description": "chamados (padrão) = uma linha por chamado; historico = uma linha por mudança de situação de cada chamado, com a observação e quem mudou", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do chamado; sem ele só entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "assunto_id", "in": "query", "required": false, "description": "assuntos do chamado — aceita vários: `assunto_id=1,2` ou `assunto_id[]=1&assunto_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "forma_atendimento_id", "in": "query", "required": false, "description": "formas de atendimento — aceita vários: `forma_atendimento_id=1,2` ou `forma_atendimento_id[]=1&forma_atendimento_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "atendente_id", "in": "query", "required": false, "description": "usuários atendentes do chamado — ids em `/usuarios` — aceita vários: `atendente_id=1,2` ou `atendente_id[]=1&atendente_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "chamados": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "codigo": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "nome_assunto": { "type": "string" }, "cliente_id": { "type": "string" }, "nome_cliente": { "type": "string" }, "nome_atendente": { "type": "string" }, "descricao": { "type": "string" }, "cadastrado_em": { "type": "string" }, "atributos": { "type": "object", "properties": [] } } } }, "por_situacao": { "type": "array", "items": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome": { "type": "string" }, "quantidade": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data de abertura do chamado", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 1, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "chamados": 1 }, "itens": [ { "id": "208", "codigo": "9001", "situacao_id": "304276", "nome_situacao": "Em aberto (TESTE GCK-22598)", "nome_assunto": "Dúvida (TESTE GCK-22598)", "cliente_id": "58634", "nome_cliente": "Cliente TESTE SR", "nome_atendente": "Atendente TESTE GCK-22598", "descricao": "Chamado de teste da API (TESTE GCK-22598)", "cadastrado_em": "2026-10-02 09:30:00", "atributos": [] } ], "por_situacao": [ { "situacao_id": "304276", "nome": "Em aberto (TESTE GCK-22598)", "quantidade": 1 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Chamados/gerar_relatorios", "x-periodo": { "data": "a data de abertura do chamado", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "data.totais.chamados é o número de chamados do período; no modo historico, totais.linhas_historico conta as mudanças de situação (um chamado aparece várias vezes — nunca conte as linhas como chamados). data.por_situacao (só no modo chamados) divide os chamados pela situação atual. Sem situacao_id ficam de fora as situações que a empresa esconde da listagem (em geral as finalizadas): para \"quantos chamados foram abertos\" passe todas as situações. Cite o período de meta.periodo. data.itens é só uma página.", "description": "Chamados do período com a descrição e os campos extras, já contados — a mesma regra do relatório da tela Atendimentos > Relatórios > Chamados. No modo histórico, uma linha por mudança de situação.\n\nSem exportação para Excel. Mesmas restrições da tela: lojas do usuário da chave e, sem `Atendimentos/Chamados/liberado_usuario`, só os chamados dele e os sem atendente.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data de abertura do chamado. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Atendimentos/Chamados/gerar_relatorios` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_atendimentos": { "get": { "tags": [ "Atendimentos" ], "summary": "Listar situações de atendimento", "operationId": "atendimentos_situacoes_atendimentos_listar", "x-modulo": "atendimentos", "x-recurso": "situacoes_atendimentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome da situação", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página (padrão e máximo 100)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "integer" }, "exibir_listagem": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 2 }, "itens": [ { "id": "304276", "nome": "Em aberto (TESTE GCK-22598)", "cor": "#f39c12", "ordem": 1, "exibir_listagem": 1, "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" }, { "id": "304277", "nome": "Resolvido (TESTE GCK-22598)", "cor": "#00a65a", "ordem": 2, "exibir_listagem": 0, "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Situacoes/index", "x-ia": "Para contar todos os chamados em /chamados, passe em situacao_id os ids desta lista — sem situacao_id a listagem esconde as situações com exibir_listagem = 0. data.totais.quantidade conta todas as situações da busca.", "description": "Situações que um chamado pode ter (Atendimentos > Situações), na ordem definida pela empresa, só leitura. É a fonte do situacao_id que /chamados e /relatorios/chamados aceitam como filtro.\n\nCadastro da empresa: não há filtro de loja nem de período. Ordem: a da tela (campo `ordem`). `exibir_listagem` 1 = a situação aparece na listagem de chamados quando nenhuma situação é informada; 0 = fica escondida (em geral as finalizadas). `cor` é hexadecimal.\n\n**Permissão exigida:** `Atendimentos/Situacoes/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_atendimentos/{id}": { "get": { "tags": [ "Atendimentos" ], "summary": "Visualizar situações de atendimento", "operationId": "atendimentos_situacoes_atendimentos_visualizar", "x-modulo": "atendimentos", "x-recurso": "situacoes_atendimentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "integer" }, "exibir_listagem": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "304276", "nome": "Em aberto (TESTE GCK-22598)", "cor": "#f39c12", "ordem": 1, "exibir_listagem": 1, "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Atendimentos/Situacoes/visualizar", "description": "404 quando a situação não existe ou é de outra empresa. Os grupos de usuário vinculados à situação na tela não vêm na API.\n\n**Permissão exigida:** `Atendimentos/Situacoes/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/agendamentos": { "get": { "tags": [ "Agenda" ], "summary": "Listar compromissos da agenda", "operationId": "agenda_agendamentos_listar", "x-modulo": "agenda", "x-recurso": "agendamentos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data do compromisso)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial no título ou na descrição do compromisso", "schema": { "type": "string" } }, { "name": "entidade", "in": "query", "required": false, "description": "string — busca parcial no nome do cliente, fornecedor, transportadora, funcionário ou contato (outros) do compromisso", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string — CPF ou CNPJ exato do cliente, fornecedor ou transportadora do compromisso", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "pedido_id", "in": "query", "required": false, "description": "int — compromissos vinculados a esta venda/ordem de serviço (id, não o número)", "schema": { "type": "string" } }, { "name": "contrato_id", "in": "query", "required": false, "description": "int — compromissos vinculados a este contrato (id)", "schema": { "type": "string" } }, { "name": "movimentacao_id", "in": "query", "required": false, "description": "int — compromissos vinculados a esta conta a pagar/receber (id)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do compromisso (cadastro da empresa em Agenda > Situações); sem ele só entram as situações marcadas para aparecer na listagem — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "usuario_agenda_id", "in": "query", "required": false, "description": "dono(s) da agenda; só vale para quem tem Agenda/Agendamentos/liberado_usuario — sem a permissão é sempre a agenda do usuário da chave — ids em `/usuarios` — aceita vários: `usuario_agenda_id=1,2` ou `usuario_agenda_id[]=1&usuario_agenda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "compromissos": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "entidade": { "type": "string" }, "nome_tipo_entidade": { "type": "string" }, "nome_entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "transportadora_id": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_usuario_agenda": { "type": "string" } } } }, "por_situacao": { "type": "array", "items": { "type": "object", "properties": { "situacao_id": { "type": "string" }, "nome": { "type": "string" }, "quantidade": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data do compromisso", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "compromissos": 2 }, "itens": [ { "id": "440", "nome": "Visita ao cliente (TESTE GCK-22598)", "data": "2026-10-27", "hora": "10:00", "situacao_id": "2269", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "C", "nome_tipo_entidade": "Cliente", "nome_entidade": "Cliente TESTE SR", "cliente_id": "58634", "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598" }, { "id": "441", "nome": "Ligação de retorno (TESTE GCK-22598)", "data": "2026-10-27", "hora": "15:30", "situacao_id": "2269", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "O", "nome_tipo_entidade": "Outros", "nome_entidade": "Fornecedor parceiro (TESTE GCK-22598)", "cliente_id": null, "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598" } ], "por_situacao": [ { "situacao_id": "2269", "nome": "Agendado (TESTE GCK-22598)", "quantidade": 2 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Agenda/Agendamentos/index", "x-periodo": { "data": "a data do compromisso", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "Compromisso é um item da agenda (visita, ligação, reunião) — não é venda nem tarefa do CRM. data.totais.compromissos conta os compromissos do período e data.por_situacao divide por situação; cite o período de meta.periodo. Sem situacao_id a listagem ESCONDE as situações que a empresa marcou para não aparecer (em geral as concluídas): \"nada na agenda\" sem situacao_id não quer dizer que não houve compromisso — para \"o que foi feito\", use /relatorios/agendamentos ou passe as situações. nome_usuario_agenda é o dono da agenda. Descrição, local e vínculos só em /agendamentos/{id}. data.itens é só uma página.", "description": "Compromissos da agenda (tela Agenda > Minha agenda), só leitura. A listagem traz os compromissos do período com a contagem por situação; /agendamentos/dia traz todos os compromissos de um dia; o detalhe traz descrição, local, histórico de situações, avisos e o vínculo com venda, contrato, conta ou tarefa.\n\nMesmas restrições da tela: lojas do usuário da chave e, sem a permissão `Agenda/Agendamentos/liberado_usuario` (Acessar de outros funcionários), só a agenda dele. Com a permissão e sem `usuario_agenda_id`, entram as agendas de todos os usuários (o que a busca avançada da tela faz). Ordem: data e hora.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do compromisso. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Agenda/Agendamentos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/agendamentos/{id}": { "get": { "tags": [ "Agenda" ], "summary": "Visualizar compromissos da agenda", "operationId": "agenda_agendamentos_visualizar", "x-modulo": "agenda", "x-recurso": "agendamentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "entidade": { "type": "string" }, "nome_tipo_entidade": { "type": "string" }, "nome_entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "transportadora_id": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_usuario_agenda": { "type": "string" }, "usuario_agenda_id": { "type": "string" }, "loja_id": { "type": "string" }, "descricao": { "type": "string" }, "local": { "type": "string" }, "recorrente": { "type": "integer" }, "nome_responsavel": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" }, "vinculos": { "type": "object", "properties": [] }, "historico": { "type": "object", "properties": [] }, "avisos": { "type": "object", "properties": [] } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "440", "nome": "Visita ao cliente (TESTE GCK-22598)", "data": "2026-10-27", "hora": "10:00", "situacao_id": "2269", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "C", "nome_tipo_entidade": "Cliente", "nome_entidade": "Cliente TESTE SR", "cliente_id": "58634", "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "usuario_agenda_id": "45", "loja_id": "65", "descricao": "Apresentar proposta (TESTE GCK-22598)", "local": "Escritório do cliente", "recorrente": 0, "nome_responsavel": "Usuário TESTE GCK-22598", "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28", "vinculos": [], "historico": [], "avisos": [] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Agenda/Agendamentos/visualizar", "x-ia": "404 também quando o compromisso é de uma loja que o usuário da chave não acessa ou, sem Agenda/Agendamentos/liberado_usuario, da agenda de outro usuário. hora vazia = compromisso sem horário (dia inteiro).", "description": "`vinculos` traz a venda/ordem de serviço (`pedido`), o contrato, a conta (`movimentacao_financeira`) ou a tarefa ligada ao compromisso; `historico` traz cada mudança de situação (mais nova primeiro); `avisos` são os lembretes configurados (`enviado` 1 = já disparado).\n\n**Permissão exigida:** `Agenda/Agendamentos/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/agendamentos/dia": { "get": { "tags": [ "Agenda" ], "summary": "Agenda do dia compromissos da agenda", "operationId": "agenda_agendamentos_dia", "x-modulo": "agenda", "x-recurso": "agendamentos", "x-operacao": "dia", "parameters": [ { "name": "data", "in": "query", "required": false, "description": "AAAA-MM-DD — obrigatório; o dia consultado", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "data": { "type": "string" }, "totais": { "type": "object", "properties": { "compromissos": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "entidade": { "type": "string" }, "nome_tipo_entidade": { "type": "string" }, "nome_entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "transportadora_id": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_usuario_agenda": { "type": "string" }, "usuario_agenda_id": { "type": "string" }, "loja_id": { "type": "string" }, "descricao": { "type": "string" }, "local": { "type": "string" }, "recorrente": { "type": "integer" }, "nome_responsavel": { "type": "string" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "data": "2026-10-27", "totais": { "compromissos": 2 }, "itens": [ { "id": "440", "nome": "Visita ao cliente (TESTE GCK-22598)", "data": "2026-10-27", "hora": "10:00", "situacao_id": "2269", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "C", "nome_tipo_entidade": "Cliente", "nome_entidade": "Cliente TESTE SR", "cliente_id": "58634", "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "usuario_agenda_id": "45", "loja_id": "65", "descricao": "Apresentar proposta (TESTE GCK-22598)", "local": "Escritório do cliente", "recorrente": 0, "nome_responsavel": "Usuário TESTE GCK-22598", "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" }, { "id": "441", "nome": "Ligação de retorno (TESTE GCK-22598)", "data": "2026-10-27", "hora": "15:30", "situacao_id": "2269", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "O", "nome_tipo_entidade": "Outros", "nome_entidade": "Fornecedor parceiro (TESTE GCK-22598)", "cliente_id": null, "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "usuario_agenda_id": "45", "loja_id": "65", "descricao": "Retornar contato (TESTE GCK-22598)", "local": "", "recorrente": 0, "nome_responsavel": "Usuário TESTE GCK-22598", "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Agenda/Agendamentos/visualizar", "x-ia": "Use para \"o que tenho hoje/amanhã\": data.totais.compromissos é o total do dia e data.itens é a lista inteira (sem paginação). Diferente de /agendamentos, aqui entram também as situações escondidas da listagem.", "description": "Todos os compromissos do dia, em ordem de hora, com descrição e local — a visão de um dia da tela. Entram todas as situações e todas as lojas do usuário da chave; com `Agenda/Agendamentos/liberado_usuario`, as agendas de todos os usuários. Sem paginação.\n\n**Permissão exigida:** `Agenda/Agendamentos/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/agendamentos/proximos": { "get": { "tags": [ "Agenda" ], "summary": "Próximos compromissos compromissos da agenda", "operationId": "agenda_agendamentos_proximos", "x-modulo": "agenda", "x-recurso": "agendamentos", "x-operacao": "proximos", "parameters": [ { "name": "limite", "in": "query", "required": false, "description": "int — quantos compromissos trazer, de 1 a 20 (padrão 6, o do card da dashboard)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "a_partir_de": { "type": "string" }, "limite": { "type": "integer" }, "totais": { "type": "object", "properties": { "compromissos": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "situacao_id": { "type": "string" }, "nome_situacao": { "type": "string" }, "entidade": { "type": "string" }, "nome_tipo_entidade": { "type": "string" }, "nome_entidade": { "type": "string" }, "cliente_id": { "type": "string" }, "fornecedor_id": { "type": [ "string", "null" ] }, "transportadora_id": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_usuario_agenda": { "type": "string" }, "descricao": { "type": "string" }, "nome_responsavel": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "data": { "a_partir_de": "2026-10-29", "limite": 6, "totais": { "compromissos": 2 }, "itens": [ { "id": "443", "nome": "Retorno ao cliente (TESTE GCK-22721)", "data": "2027-01-15", "hora": "10:00", "situacao_id": "2269", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "C", "nome_tipo_entidade": "Cliente", "nome_entidade": "Cliente TESTE SR", "cliente_id": "58634", "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "descricao": "Ligar para confirmar proposta (TESTE GCK-22721)", "nome_responsavel": "Usuário TESTE GCK-22598" }, { "id": "444", "nome": "Visita técnica (TESTE GCK-22721)", "data": "2027-01-20", "hora": null, "situacao_id": "2269", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "C", "nome_tipo_entidade": "Cliente", "nome_entidade": "Cliente TESTE SR", "cliente_id": "58634", "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "descricao": "Dia inteiro (TESTE GCK-22721)", "nome_responsavel": "Usuário TESTE GCK-22598" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Agenda/Agendamentos/index", "x-ia": "Use para \"qual meu próximo compromisso\" ou \"o que tenho pela frente\". É a agenda de quem é dono da chave, não a da empresa — para outro usuário ou um período, use /agendamentos com usuario_agenda_id e data_inicio/data_fim. data.itens já vem limitado a `limite` (sem paginação); data.totais.compromissos é quantos vieram, não o total de compromissos futuros.", "description": "O card \"Próximos compromissos\" da dashboard: de hoje em diante, por data e hora, até `limite`. Entram os de hoje que ainda não passaram (hora a partir de uma hora atrás, ou sem hora) e os dos próximos dias. Só a agenda do usuário da chave (dono do compromisso, mesmo com `Agenda/Agendamentos/liberado_usuario`), só as lojas que ele acessa e só as situações com `exibir_listagem` = 1. Exige também `Dashboard/mostrar_agenda`, como o card. Só lê: não marca nada como concluído. `a_partir_de` é a data de hoje no fuso da loja.\n\n**Permissão exigida:** `Agenda/Agendamentos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/relatorios/agendamentos": { "get": { "tags": [ "Agenda" ], "summary": "Consultar relatório de compromissos", "operationId": "agenda_relatorio_agendamentos_listar", "x-modulo": "agenda", "x-recurso": "relatorio_agendamentos", "x-operacao": "listar", "parameters": [ { "name": "data_inicio", "in": "query", "required": false, "description": "AAAA-MM-DD — início do período (data do compromisso)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "AAAA-MM-DD — fim do período", "schema": { "type": "string" } }, { "name": "loja_id", "in": "query", "required": false, "description": "int — uma loja; sem ele entram todas as lojas que o usuário da chave acessa", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string — busca parcial no título ou na descrição", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int — um cliente — ids em `/clientes`", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int — um fornecedor — ids em `/fornecedores`", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int — uma transportadora — ids em `/transportadoras`", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int — um funcionário vinculado ao compromisso — ids em `/funcionarios`", "schema": { "type": "string" } }, { "name": "outros", "in": "query", "required": false, "description": "string — busca parcial no contato avulso (entidade O = outros)", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "situações do compromisso; sem ele entram TODAS as situações — aceita vários: `situacao_id=1,2` ou `situacao_id[]=1&situacao_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "usuario_agenda_id", "in": "query", "required": false, "description": "dono(s) da agenda; sem Agenda/Agendamentos/liberado_usuario é sempre a agenda do usuário da chave — ids em `/usuarios` — aceita vários: `usuario_agenda_id=1,2` ou `usuario_agenda_id[]=1&usuario_agenda_id[]=2`", "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pagina", "in": "query", "description": "Página da lista em data.itens (os totais são sempre do período inteiro)", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Itens por página (máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 100, "maximum": 100 } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "periodo": { "type": "object", "properties": { "data": { "type": "string" }, "inicio": { "type": "string" }, "fim": { "type": "string" }, "padrao": { "type": "boolean" } } }, "loja_id": { "type": "array", "items": { "type": "integer" } }, "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "compromissos": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "data": { "type": "string" }, "hora": { "type": "string" }, "nome_situacao": { "type": "string" }, "entidade": { "type": "string" }, "nome_entidade": { "type": "string" }, "cliente_id": { "type": [ "string", "null" ] }, "fornecedor_id": { "type": [ "string", "null" ] }, "transportadora_id": { "type": [ "string", "null" ] }, "funcionario_id": { "type": [ "string", "null" ] }, "nome_usuario_agenda": { "type": "string" }, "descricao": { "type": "string" }, "local": { "type": "string" } } } }, "por_situacao": { "type": "array", "items": { "type": "object", "properties": { "nome": { "type": "string" }, "quantidade": { "type": "integer" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "periodo": { "data": "a data do compromisso", "inicio": "2026-10-01", "fim": "2026-10-31", "padrao": true }, "loja_id": [ 79893, 79928, 79949, 79993, 80039, 80042, 80062, 80089, 80096, 80105, 79986, 80121, 79929, 80154, 80117, 80157, 80158, 79814, 80542, 80086, 80462, 80764, 80773, 65 ], "total_registros": 3, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "compromissos": 3 }, "itens": [ { "id": "442", "nome": "Reunião concluída (TESTE GCK-22598)", "data": "2026-10-01", "hora": "09:00", "nome_situacao": "Realizado (TESTE GCK-22598)", "entidade": "O", "nome_entidade": "Fornecedor parceiro (TESTE GCK-22598)", "cliente_id": null, "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "descricao": "Reunião já feita (TESTE GCK-22598)", "local": "" }, { "id": "440", "nome": "Visita ao cliente (TESTE GCK-22598)", "data": "2026-10-27", "hora": "10:00", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "C", "nome_entidade": "Cliente TESTE SR", "cliente_id": "58634", "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "descricao": "Apresentar proposta (TESTE GCK-22598)", "local": "Escritório do cliente" }, { "id": "441", "nome": "Ligação de retorno (TESTE GCK-22598)", "data": "2026-10-27", "hora": "15:30", "nome_situacao": "Agendado (TESTE GCK-22598)", "entidade": "O", "nome_entidade": "Fornecedor parceiro (TESTE GCK-22598)", "cliente_id": null, "fornecedor_id": null, "transportadora_id": null, "funcionario_id": null, "nome_usuario_agenda": "Usuário TESTE GCK-22598", "descricao": "Retornar contato (TESTE GCK-22598)", "local": "" } ], "por_situacao": [ { "nome": "Realizado (TESTE GCK-22598)", "quantidade": 1 }, { "nome": "Agendado (TESTE GCK-22598)", "quantidade": 2 } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Agenda/RelatoriosAgendamentos/relatorio_agendamentos", "x-periodo": { "data": "a data do compromisso", "padrao": "mês atual", "teto_meses": 12 }, "x-ia": "data.totais.compromissos é o total do período e data.por_situacao divide pelo nome da situação gravado no compromisso. Diferente de /agendamentos, aqui entram todas as situações quando situacao_id não vem — é o lugar para \"quantos compromissos tive/fiz no mês\". entidade: C cliente, F fornecedor, T transportadora, U funcionário, O outros. Cite o período de meta.periodo. data.itens é só uma página — nunca some as linhas.", "description": "Compromissos do período com descrição e local, já contados — a mesma regra do relatório da tela Agenda > Relatórios > Gerar relatório.\n\nMesmas restrições da tela: lojas do usuário da chave e, sem `Agenda/Agendamentos/liberado_usuario`, só a agenda dele; com a permissão e sem `usuario_agenda_id`, todas as agendas.\n\n**Período:** `data_inicio` e `data_fim` (AAAA-MM-DD) filtram a data do compromisso. Sem elas: mês atual. Máximo: 12 meses.\n\n**Permissão exigida:** `Agenda/RelatoriosAgendamentos/relatorio_agendamentos` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_agendamentos": { "get": { "tags": [ "Agenda" ], "summary": "Listar situações de compromisso", "operationId": "agenda_situacoes_agendamentos_listar", "x-modulo": "agenda", "x-recurso": "situacoes_agendamentos", "x-operacao": "listar", "parameters": [ { "name": "nome", "in": "query", "required": false, "description": "string — trecho do nome da situação", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "required": false, "description": "int — página de data.itens (padrão 1)", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "required": false, "description": "int — itens por página (padrão e máximo 100)", "schema": { "type": "string" } }, { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (padrão 20, máximo 100; acima de 100 volta 100 sem avisar)", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "ordenacao", "in": "query", "description": "Campo de ordenação", "schema": { "type": "string" } }, { "name": "direcao", "in": "query", "description": "asc ou desc", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "meta": { "type": "object", "properties": { "total_registros": { "type": "integer" }, "pagina": { "type": "integer" }, "limite": { "type": "integer" }, "total_paginas": { "type": "integer" }, "cache": { "type": "boolean" } } }, "data": { "type": "object", "properties": { "totais": { "type": "object", "properties": { "quantidade": { "type": "integer" } } }, "itens": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "integer" }, "exibir_listagem": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } } } } }, "example": { "code": 200, "status": "success", "meta": { "total_registros": 2, "pagina": 1, "limite": 100, "total_paginas": 1, "cache": false }, "data": { "totais": { "quantidade": 2 }, "itens": [ { "id": "2269", "nome": "Agendado (TESTE GCK-22598)", "cor": "#3c8dbc", "ordem": 1, "exibir_listagem": 1, "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" }, { "id": "2270", "nome": "Realizado (TESTE GCK-22598)", "cor": "#00a65a", "ordem": 2, "exibir_listagem": 0, "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" } ] } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Agenda/SituacoesAgendamentos/index", "x-ia": "Para contar todos os compromissos em /agendamentos, passe em situacao_id os ids desta lista — sem situacao_id a listagem esconde as situações com exibir_listagem = 0. data.totais.quantidade conta todas as situações da busca.", "description": "Situações que um compromisso da agenda pode ter (Agenda > Situações), na ordem definida pela empresa, só leitura. É a fonte do situacao_id que /agendamentos e /relatorios/agendamentos aceitam como filtro.\n\nCadastro da empresa: não há filtro de loja nem de período. Ordem: a da tela (campo `ordem`). `exibir_listagem` 1 = a situação aparece na listagem de compromissos e nos próximos compromissos quando nenhuma situação é informada; 0 = fica escondida (em geral as concluídas). `cor` é hexadecimal.\n\n**Permissão exigida:** `Agenda/SituacoesAgendamentos/index` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/situacoes_agendamentos/{id}": { "get": { "tags": [ "Agenda" ], "summary": "Visualizar situações de compromisso", "operationId": "agenda_situacoes_agendamentos_visualizar", "x-modulo": "agenda", "x-recurso": "situacoes_agendamentos", "x-operacao": "visualizar", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Identificador do registro", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sucesso", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "nome": { "type": "string" }, "cor": { "type": "string" }, "ordem": { "type": "integer" }, "exibir_listagem": { "type": "integer" }, "cadastrado_em": { "type": "string" }, "modificado_em": { "type": "string" } } } } }, "example": { "code": 200, "status": "success", "data": { "id": "2269", "nome": "Agendado (TESTE GCK-22598)", "cor": "#3c8dbc", "ordem": 1, "exibir_listagem": 1, "cadastrado_em": "2026-10-27 20:18:28", "modificado_em": "2026-10-27 20:18:28" } } } } }, "401": { "description": "Token não informado ou inválido", "content": { "application/json": { "example": { "code": 401, "status": "error", "data": { "erro": "Unauthorized", "mensagem": "Access Token não informado!" } } } } }, "402": { "description": "Plano não permite integrar com API", "content": { "application/json": { "example": { "code": 402, "status": "error", "data": { "mensagem": "O seu plano atual não permite integrar com API. Por favor, contrate outro plano!" } } } } }, "403": { "description": "Usuário sem permissão para o recurso" }, "404": { "description": "Registro não encontrado" }, "429": { "description": "Limite de requisições atingido (3/s, 30.000/dia por empresa)", "content": { "application/json": { "example": { "code": 429, "status": "error", "data": { "mensagem": "O limite de requisicoes foi atingido" } } } } } }, "x-permissao": "Agenda/SituacoesAgendamentos/visualizar", "description": "404 quando a situação não existe ou é de outra empresa.\n\n**Permissão exigida:** `Agenda/SituacoesAgendamentos/visualizar` (a mesma da tela do sistema).", "servers": [ { "url": "https://app.api.click.app/v1" } ] } } }, "components": { "securitySchemes": { "accessToken": { "type": "apiKey", "in": "header", "name": "access-token" }, "secretAccessToken": { "type": "apiKey", "in": "header", "name": "secret-access-token" } } }, "security": [ { "accessToken": [], "secretAccessToken": [] } ], "x-modalidade": "ERP" }