{ "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" } ], "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": "Compras", "description": "Compras e suas situações.", "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": "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" } ], "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": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = Estrangeiro", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "1 = ativo, 0 = inativo", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica, ES = Estrangeiro", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "cpf_cnpj", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "1 = ativo, 0 = inativo", "schema": { "type": "string" } }, { "name": "cidade_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "required": false, "description": "string", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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", "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 (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "**Campos obrigatórios:** `nome`, `tipo`, `opcoes`", "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": "**Campos obrigatórios:** `nome`, `tipo`, `opcoes`", "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": "tipo_pessoa", "in": "query", "required": false, "description": "PF = pessoa física, PJ = pessoa jurídica", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "estado_id", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "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", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "grupo_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "1 = sim, 0 = nã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 (máximo 100)", "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" } } } } } }, "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" } } ], "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" } } } } } }, "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" } ] } }, "/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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "**Campos obrigatórios:** `nome`, `tipo`, `opcoes`", "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": "**Campos obrigatórios:** `nome`, `tipo`, `opcoes`", "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", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "float", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "float", "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 (máximo 100)", "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" } } } } } }, "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" } ] } }, "/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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "loja_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "tipo = produto, tipo = servico", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": ":", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": ":", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`, `opcoes`", "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": "**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`, `opcoes`", "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": "loja_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "tipo = produto, tipo = servico, tipo = vendas_balcao", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": ":", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": ":", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`, `opcoes`", "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": "**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`, `opcoes`", "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": "loja_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": ":", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": ":", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`, `opcoes`", "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": "**Campos obrigatórios:** `nome`, `tipo`, `exibir_impressao`, `opcoes`", "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" } ] } }, "/compras": { "get": { "tags": [ "Compras" ], "summary": "Listar compras", "operationId": "estoque_compras_listar", "x-modulo": "estoque", "x-recurso": "compras", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "situacao_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "post": { "tags": [ "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": [ "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" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "put": { "tags": [ "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": [ "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": [ "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": [ "Compras" ], "summary": "Listar situações de compras", "operationId": "estoque_situacoes_compras_listar", "x-modulo": "estoque", "x-recurso": "situacoes_compras", "x-operacao": "listar", "parameters": [ { "name": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "loja_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "float", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "float", "schema": { "type": "string" } }, { "name": "liquidado", "in": "query", "required": false, "description": "ab = Em aberto, at = Em atraso, pg = Confirmado", "schema": { "type": "string" } }, { "name": "plano_contas_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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" } ] } }, "/recebimentos": { "get": { "tags": [ "Financeiro" ], "summary": "Listar recebimentos", "operationId": "financeiro_recebimentos_listar", "x-modulo": "financeiro", "x-recurso": "recebimentos", "x-operacao": "listar", "parameters": [ { "name": "loja_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "codigo", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "cliente_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "fornecedor_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "transportadora_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "funcionario_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "valor_inicio", "in": "query", "required": false, "description": "float", "schema": { "type": "string" } }, { "name": "valor_fim", "in": "query", "required": false, "description": "float", "schema": { "type": "string" } }, { "name": "liquidado", "in": "query", "required": false, "description": "ab = Em aberto, at = Em atraso, pg = Confirmado", "schema": { "type": "string" } }, { "name": "plano_contas_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "centro_custo_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "conta_bancaria_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "forma_pagamento_id", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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" } ] } }, "/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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "**Campos obrigatórios:** `nome`, `tipo`, `opcoes`", "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": "**Campos obrigatórios:** `nome`, `tipo`, `opcoes`", "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "D = Débito, C = Crédito", "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 (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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": "pagina", "in": "query", "description": "Página da listagem", "schema": { "type": "integer", "default": 1 } }, { "name": "limite", "in": "query", "description": "Registros por página (máximo 100)", "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" }, "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": "", "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" } } } } } }, "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" }, "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, "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" }, "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", "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" } } } } } }, "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" } } }, "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 } } } } }, "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" } } } } } }, "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" } } } } } }, "servers": [ { "url": "https://app.api.click.app/v1" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "motivo": { "type": "integer" } } }, "example": { "motivo": 1 } } } } } }, "/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", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "CO = contrato de serviço, LO = locação, EM = empréstimo, SR = assinatura", "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 (Y-m-d)", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string (Y-m-d)", "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 (máximo 100)", "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" } } } } } }, "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.", "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" } } } } } }, "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" } } } } } }, "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`", "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", "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. 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", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "produto", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "servico", "in": "query", "required": false, "description": "int", "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 (máximo 100)", "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" } } } } } }, "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.", "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" } } } } } }, "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" } } } } } }, "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`", "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 (máximo 100)", "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" } } } } } }, "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", "schema": { "type": "string" } }, { "name": "tipo", "in": "query", "required": false, "description": "LO = locação, EM = empréstimo", "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. 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", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "gerar-fatura", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "envio", "in": "query", "required": false, "description": "1 = enviado por e-mail, 0 = não enviado", "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 (máximo 100)", "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" } } } } } }, "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.", "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" } } } } } }, "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" } } } } } }, "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`", "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 (máximo 100)", "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" } } } } } }, "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", "schema": { "type": "string" } }, { "name": "nome", "in": "query", "required": false, "description": "string", "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. 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", "schema": { "type": "string" } }, { "name": "plano", "in": "query", "required": false, "description": "int", "schema": { "type": "string" } }, { "name": "detalhes", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "string", "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 (máximo 100)", "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" } } } } } }, "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, 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.", "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" } } } } } }, "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" } } } } } }, "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`", "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 (máximo 100)", "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": "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 (máximo 100)", "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 (máximo 100)", "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" } } } } } }, "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` | escolha entre as `opcoes` do próprio campo |\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`; 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" } ] } }, "/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", "schema": { "type": "string" } }, { "name": "email", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "cpf", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "telefone", "in": "query", "required": false, "description": "string", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "DD/MM/YYYY", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "DD/MM/YYYY", "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" } }, "description": "Contatos signatários cadastrados na empresa.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "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" } ], "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" } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "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" } ], "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" } ] } }, "/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" } }, "description": "Documentos em que o contato aparece como signatário, com a situação de cada assinatura.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/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": "Filtro por nome do documento", "schema": { "type": "string" } }, { "name": "contato", "in": "query", "required": false, "description": "Filtro por nome do signatário", "schema": { "type": "string" } }, { "name": "loja", "in": "query", "required": false, "description": "int — id da loja (obtido em /api/lojas)", "schema": { "type": "string" } }, { "name": "situacao", "in": "query", "required": false, "description": "pendente, assinado, cancelado ou expirado", "schema": { "type": "string" } }, { "name": "data_inicio", "in": "query", "required": false, "description": "DD/MM/YYYY", "schema": { "type": "string" } }, { "name": "data_fim", "in": "query", "required": false, "description": "DD/MM/YYYY", "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" } }, "description": "Documentos enviados para assinatura eletrônica.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "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" } ], "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" } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "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" } ], "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" } ] } }, "/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" } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/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" } }, "description": "Documento já cancelado não pode ser cancelado de novo.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/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" } }, "description": "Reenvia por e-mail a todos os signatários pendentes. Documento já assinado não pode ser reenviado.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/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", "schema": { "type": "string" } }, { "name": "ativo", "in": "query", "required": false, "description": "boolean", "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.", "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/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" } ] }, "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" } ] } }, "/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" } }, "description": "tipo: link | email | preenchimento. Com email, a chave email (array) é obrigatória; com preenchimento, a chave campos.\n\n**Campos obrigatórios:** `tipo`", "servers": [ { "url": "https://app.api.click.app/v1" } ], "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": "Filtro por nome da pasta", "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" } }, "description": "Pastas que organizam os documentos, com controle de acesso por usuário.", "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "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" } ], "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" } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] }, "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" } ], "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" } ] } }, "/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" } }, "servers": [ { "url": "https://app.api.click.app/v1" } ] } }, "/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" } ] } } }, "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" }