{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d39670cd-7f3d-4eb0-bb8d-82c089d1e8b9","name":"API - IXC Franquias","description":"> **Última atualização:**  \n02/01/2026 - Documentação baseada nas versões atuais da API IXC Franquias \n  \n\n---\n\n# 📄 **Visão Geral**\n\nA API do IXC Franquias, baseada na API do IXC Provedor, disponibiliza endpoints para integração com dados operacionais, comerciais, financeiros e de suporte do sistema IXC. Esta documentação apresenta as requisições mais utilizadas, servindo como base para integrações.\n\n**⚠️ Importante:**\n\n- Esta documentação não contempla **todas** as rotas disponíveis\n    \n- Foram priorizados os endpoints mais utilizados em integrações reais\n    \n- Nem todas as rotas do IXC Provedor estão documentadas aqui\n    \n\n---\n\n## 🚀 **Primeiros Passos**\n\n### **Pré-requisitos**\n\n1. **Gere um usuário WebService** no IXC Franquias\n    \n2. **Ative** a opção \"Permite acesso WebService\" para o usuário\n    \n3. **Gere o token** de acesso\n    \n4. **Libere o IP** de origem da requisição nas configurações do grupo de usuários\n    \n\n### **Configuração Básica**\n\n- Todas as requisições utilizam **HTTPS**\n    \n- Respostas no formato **JSON**\n    \n- **Basic Auth** obrigatório em todas as requisições\n    \n\n---\n\n## 🔐 **Autenticação**\n\n### **Tipo**\n\n`Basic Auth`\n\n### **Credenciais**\n\n- **Username:** Informação contida antes dos `:` no campo \"Token de acesso\" no usuário utilizado para acesso webservice.\n    \n- **Password:** Informação contida após os `:` no campo \"Token de acesso\" no usuário utilizado para acesso webservice.\n    \n\n### **Headers Obrigatórios**\n\nPara requisições **GET**, inclua obrigatoriamente: `ixcsoft: listar`\n\n### **Erros de Autenticação Comuns**\n\n| Código | Descrição |\n| --- | --- |\n| `401` | Token inválido, usuário inativo ou IP não liberado |\n| `403` | Token inválido após migração de servidor |\n| `404` | Header obrigatório ausente em requisições GET |\n\n**Solução:** Verifique token, status do usuário, liberação de IP ou recrie o token.\n\n---\n\n# 📊 **Métodos HTTP Disponíveis**\n\n| Método | Descrição | Uso Principal |\n| --- | --- | --- |\n| **GET** | Listagem e consulta de dados | Consultas com filtros e paginação |\n| **POST** | Inserção de registros | Criar novos registros |\n| **PUT** | Atualização de registros | Atualizar registros existentes |\n| **DELETE** | Exclusão de registros | Remover registros |\n\n---\n\n## 🟢 **GET – Listagem de Dados**\n\n### **Estrutura Padrão**\n\n``` json\n{\n  \"qtype\": \"tabela.campo\",\n  \"query\": \"valor\",\n  \"oper\": \"operador\",\n  \"page\": \"1\",\n  \"rp\": \"20\",\n  \"sortname\": \"tabela.campo\",\n  \"sortorder\": \"desc\",\n  \"grid_param\": \"[{\\\"TB\\\":\\\"tabela.campo\\\", \\\"OP\\\":\\\"operador\\\", \\\"P\\\":\\\"valor\\\"}]\"\n}\n\n ```\n\n### **Exemplo Prático**\n\n``` bash\ncurl --request GET \"https://{{domain}}/webservice/v1/cliente\" \\\n--header \"ixcsoft: listar\" \\\n--header \"Authorization: Basic {{token_base64}}\" \\\n--header \"Content-Type: application/json\" \\\n--data-raw '{\n  \"qtype\": \"cliente.id\",\n  \"query\": \"0\",\n  \"oper\": \">\",\n  \"page\": \"{{page_default}}\",\n  \"rp\": \"{{rp_default}}\",\n  \"sortname\": \"cliente.data_cadastro\",\n  \"sortorder\": \"desc\",\n  \"grid_param\": \"[{\\\"TB\\\":\\\"cliente.ativo\\\", \\\"OP\\\":\\\"=\\\", \\\"P\\\":\\\"S\\\"}, {\\\"TB\\\":\\\"cliente.data_cadastro\\\", \\\"OP\\\":\\\">=\\\", \\\"P\\\":\\\"01/01/2024\\\"}]\"\n}'\n\n ```\n\n### **Parâmetros da Requisição**\n\n| Parâmetro | Obrigatório | Descrição | Exemplo |\n| --- | --- | --- | --- |\n| **`qtype`** | Sim | Campo base da consulta | `\"cliente.id\"` |\n| **`query`** | Sim | Valor para comparação | `\"1\"` |\n| **`oper`** | Sim | Operador lógico | `\">=\"`, `\"=\"`, `\"L\"` |\n| **`page`** | Não | Número da página | `\"1\"` |\n| **`rp`** | Não | Registros por página | `\"20\"` |\n| **`sortname`** | Não | Campo para ordenação | `\"cliente.id\"` |\n| **`sortorder`** | Não | Ordem (`asc`/`desc`) | `\"desc\"` |\n| **`grid_param`** | Não | Filtros avançados | Ver abaixo |\n\n---\n\n### **📌 grid_param – Filtros Avançados**\n\n**Estrutura:**\n\n``` json\n\"grid_param\": \"[{\\\"TB\\\":\\\"tabela.campo\\\", \\\"OP\\\":\\\"operador\\\", \\\"P\\\":\\\"valor\\\"}]\"\n\n ```\n\n**⚠️ Limitação:** API não suporta operador `OR`\n\n### **Operadores Disponíveis**\n\n| Operador | Significado | Tipo de Dado |\n| --- | --- | --- |\n| `=` | Igual | Todos |\n| `!=` | Diferente | Todos |\n| `>` | Maior | Numérico/Data |\n| `<` | Menor | Numérico/Data |\n| `>=` | Maior ou igual | Numérico/Data |\n| `<=` | Menor ou igual | Numérico/Data |\n| `L` | Contém | Texto |\n| `NL` | Não contém | Texto |\n| `IN` | Contido | Numérico |\n| `NI` | Não contido | Numérico |\n| `BE` | Entre | Intervalo |\n| `NBE` | Não está entre | Intervalo |\n\n---\n\n## 🟠 **POST – Inserção de Dados**\n\n### **Regras**\n\n- Todos os campos obrigatórios devem ser informados\n    \n- Consulte a documentação específica de cada endpoint para campos obrigatórios\n    \n\n### **Exemplo**\n\n``` json\ncurl --request POST \"https://{{domain}}/webservice/v1/cliente\" \\\n--header \"Authorization: Basic {{token_base64}}\" \\\n--header \"Content-Type: application/json\" \\\n--data-raw '{\n  \"ativo\": \"S\",\n  \"tipo_pessoa\": \"F\",\n  \"razao\": \"Maria Santos\",\n  \"fantasia\": \"Maria\",\n  \"email\": \"maria@email.com\",\n  \"cep\": \"88010-970\",\n  \"endereco\": \"Rua Principal\",\n  \"numero\": \"123\",\n  \"bairro\": \"Centro\",\n  \"cidade\": \"4376\",\n  \"uf\": \"2\",\n  \"cnpj_cpf\": \"987.654.321-00\",\n  \"telefone_celular\": \"(47) 98888-7777\",\n  \"telefone_comercial\": \"(47) 3333-4444\",\n  \"data_cadastro\": \"2024-01-15\"\n}'\n\n ```\n\n---\n\n## 🔵 **PUT – Atualização de Dados**\n\n### **⚠️ Atenção Importante**\n\n- **Não é possível** atualizar apenas um campo isoladamente\n    \n- **Todos os campos** devem ser enviados, mesmo os não alterados\n    \n- O **ID** do registro deve estar na **URL**\n    \n\n### **Exemplo**\n\n``` json\ncurl --request PUT \"https://{{domain}}/webservice/v1/cliente/150\" \\\n--header \"Authorization: Basic {{token_base64}}\" \\\n--header \"Content-Type: application/json\" \\\n--data-raw '{\n  \"ativo\": \"S\",\n  \"tipo_pessoa\": \"F\",\n  \"razao\": \"Maria Santos Costa\",\n  \"fantasia\": \"Maria Costa\",\n  \"email\": \"maria.costa@novoemail.com\",\n  \"cep\": \"88010-970\",\n  \"endereco\": \"Rua Principal\",\n  \"numero\": \"123A\",\n  \"bairro\": \"Centro\",\n  \"cidade\": \"4376\",\n  \"uf\": \"2\",\n  \"cnpj_cpf\": \"987.654.321-00\",\n  \"telefone_celular\": \"(47) 97777-6666\",\n  \"telefone_comercial\": \"(47) 3333-4444\",\n  \"observacao\": \"Atualizado em 16/01/2024\"\n  // ... todos os outros campos do cliente\n}'\n\n ```\n\n---\n\n## 🔴 **DELETE – Exclusão de Dados**\n\n### **Características**\n\n- Não possui corpo (body)\n    \n- Pode exigir exclusão de dependências antes\n    \n- ID na URL\n    \n\n### **Exemplo**\n\n``` bash\ncurl --request DELETE \"https://{{domain}}/webservice/v1/cliente/250\" \\\n--header \"Authorization: Basic {{token_base64}}\" \n\n ```\n\n---\n\n## 📊 **Uso e Limites**\n\n### **Recomendações de Performance**\n\n- Utilize **pagination** (`page` e `rp`)\n    \n- Evite consultas muito amplas sem filtros\n    \n- Prefira `grid_param` para consultas avançadas\n    \n- Monitore volume de dados retornados\n    \n\n### **Possíveis Restrições**\n\n- Volume excessivo de requisições\n    \n- Consultas com grande quantidade de dados\n    \n- Sobrecarga do servidor\n    \n\n---\n\n## ❌ **Tratamento de Erros**\n\n### **Principais Códigos HTTP**\n\n| Código | Motivo | Ação Recomendada |\n| --- | --- | --- |\n| 400 | Bad Request | Verificar payload e parâmetros |\n| 401 | Falha de autenticação | Verificar token e IP |\n| 403 | Token inválido ou migração | Recriar token |\n| 404 | Endpoint não encontrado | Verificar URL |\n| 500 | Erro interno do servidor | Contatar suporte |\n| 504 | Timeout | Reduzir volume ou otimizar consulta |\n\n### **Erros Comuns**\n\n1. **Endpoint não liberado**\n    \n2. **IP não autorizado**\n    \n3. **Token inválido**\n    \n4. **Nome de tabela incorreto**\n    \n5. **Alto volume de dados**\n    \n\n---\n\n# 🆘 **Suporte**\n\n### **Canais de Atendimento**\n\n| Tipo de Suporte | Canal |\n| --- | --- |\n| **API - Dúvidas técnicas** | 💬 Suporte API – IXC Provedor |\n| **Infraestrutura/Servidores** | 🛠️ SUP – Instalação e Manutenção |\n\n### **Informações para Contato**\n\nAo abrir um atendimento, forneça:\n\n1. **Endpoint** utilizado\n    \n2. **Método** HTTP\n    \n3. **Payload** enviado (se aplicável)\n    \n4. **Mensagem de erro** retornada\n    \n5. **Headers** utilizados\n    \n\n### **Links Úteis**\n\n- [Contato do Suporte API – IXC Provedor (WhatsApp)](https://api.whatsapp.com/send?phone=554933446001)\n    \n\n---\n\n# 📋 **Endpoints Disponíveis**\n\nA API permite, entre outras ações:\n\n- ✅ Consultar e gerenciar clientes\n    \n- ✅ Consultar contratos e produtos\n    \n- ✅ Acessar dados financeiros (títulos, boletos, cobranças)\n    \n- ✅ Consultar ordens de serviço e atendimentos\n    \n\n_Para endpoints específicos não documentados, entre em contato com o suporte API._\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"59065826","team":45414843,"collectionId":"d39670cd-7f3d-4eb0-bb8d-82c089d1e8b9","publishedId":"2sBYHSyMBH","public":true,"publicUrl":"https://api-franquias.ixcsoft.com.br","privateUrl":"https://go.postman.co/documentation/59065826-d39670cd-7f3d-4eb0-bb8d-82c089d1e8b9","customColor":{"top-bar":"E9EEFA","right-sidebar":"F0F4FF","highlight":"1ECAD3"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Documentação completa de formulários e botões do sistema empresarial. Inclui cadastro de clientes, contratos, CRM, módulo financeiro, suporte, logins e VoIP."},{"name":"title","value":"Documentação API IXC Franquias"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/be07ce9c-8eb3-45e6-b6e4-e53fc55582f6/bG9nb19peGMucG5n","colors":{"top-bar":"0A1533","right-sidebar":"0F172A","highlight":"1ECAD3"}},{"name":"light","logo":"https://content.pstmn.io/be07ce9c-8eb3-45e6-b6e4-e53fc55582f6/bG9nb19peGMucG5n","colors":{"top-bar":"E9EEFA","right-sidebar":"F0F4FF","highlight":"1ECAD3"}}]}},"version":"8.12.10","publishDate":"2026-10-27T12:22:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Documentação API IXC Franquias","description":"Documentação completa de formulários e botões do sistema empresarial. Inclui cadastro de clientes, contratos, CRM, módulo financeiro, suporte, logins e VoIP."},"logos":{"logoLight":"https://content.pstmn.io/be07ce9c-8eb3-45e6-b6e4-e53fc55582f6/bG9nb19peGMucG5n","logoDark":"https://content.pstmn.io/be07ce9c-8eb3-45e6-b6e4-e53fc55582f6/bG9nb19peGMucG5n"}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/843a04e471523fb29e7b326ecfb82a86f04292333f93b32ed74c676c83ad38da","favicon":"https://ixcsoft.com.br/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-franquias.ixcsoft.com.br/view/metadata/2sBYHSyMBH"}