{ "info": { "name": "API do Faturamento Automático (v1.0.0)", "description": "¡Tú que eres dev, diviértete! ✨\n\n> **Índice de la documentación** — accede al índice completo en [https://docs.billing.kobana.com.br/llms.txt](https://docs.billing.kobana.com.br/llms.txt). Usa este archivo para descubrir todas las páginas disponibles antes de explorar.\n\n> **Atención a las versiones de la API** — estás en la documentación de la **v1.0** de la API de Facturación Automática, que cubre los endpoints de **Suscripciones** (creación, cambio de plan, pausa, cancelación, facturación manual, sincronización de ítems) y recursos relacionados. Recursos como **Pagos, Transferencias, Extracto y Recepción por Pix** están disponibles en otras APIs de Kobana — usa el selector de producto en el menú superior para acceder.\n\n## Formato\n\nLa API solo acepta `JSON`. Todas las solicitudes deben usar `Content-Type: application/json`. Todas las respuestas usan `snake_case`.\n\n| Tipo de Campo | Formato |\n| :--- | :--- |\n| **DateTime** | Formato [ISO8601](https://es.wikipedia.org/wiki/ISO_8601). Ejemplos — Fecha: `2026-01-24`. Fecha y hora: `2026-01-24T10:07Z` |\n| **Money (`_cents`)** | Entero en centavos (÷100). Ej.: `10000` = R$ 100,00 |\n| **Money (`_subcents`)** | Entero en subcentavos (÷10000), usado en precios. Ej.: `1000000` = R$ 100,00 |\n| **UUID** | Identificadores de recursos en formato UUID v4 |\n\n## Convenciones\n\nConvenciones usadas en esta documentación:\n\n| Convención | Descripción |\n| :--- | :--- |\n| **`:variable`** | Nombre de variable que debe sustituirse en una URL. |\n| **`#{variable}`** | Nombre de variable que debe sustituirse por valores de tu cuenta. |\n| **`...`** | Contenido de la respuesta truncado para facilitar la lectura. |\n| **`$KOBANA_TOKEN`** | Token de acceso. Para pruebas en línea de comandos, expórtalo: `export KOBANA_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxx` y pega los comandos de la documentación en la terminal. |\n\n## Códigos de Retorno\n\nLa API devuelve códigos HTTP estándar:\n\n| | Código | Descripción |\n| :--- | :--- | :--- |\n| ✅ | **200 OK** | Solicitud exitosa con cuerpo de respuesta. |\n| ✅ | **201 Created** | Recurso creado con éxito. |\n| ✅ | **204 No Content** | Solicitud exitosa sin cuerpo de respuesta. |\n| ❌ | **400 Bad Request** | Solicitud inválida, generalmente contenido mal formado. |\n| ❌ | **401 Unauthorized** | Token de acceso ausente o inválido. |\n| ❌ | **403 Forbidden** | Acceso a la API bloqueado o usuario sin permiso. |\n| ❌ | **404 Not Found** | El recurso no existe. |\n| ❌ | **422 Unprocessable Entity** | Solicitud válida, pero los datos enviados no lo son. |\n| ❌ | **429 Too Many Requests** | Límite de solicitudes alcanzado. |\n| ❌ | **500 Internal Server Error** | Error interno de procesamiento. Consulta el [estado de los servidores](https://status.kobana.com.br). |\n\n## ID de las Solicitudes (Request ID)\n\nCada solicitud tiene un identificador asociado, disponible en la cabecera `Request-Id` de la respuesta. Este valor ayuda en la depuración y auditoría — las solicitudes y sus IDs pueden consultarse en el panel del sistema. El registro de solicitudes está disponible por **30 días**. Al abrir un ticket de soporte sobre una solicitud específica, informa el `Request-Id` para acelerar la investigación.\n\n## Seguridad\n\nLa API de Kobana usa certificados **SSL 2048 bits**. Toda solicitud debe hacerse vía **HTTPS** — las llamadas al puerto 80 son redirigidas al 443.\n\nLos clientes deben soportar `TLSv1.2` o `TLSv1.3` con una de las cifras: `TLS_AES_128_GCM_SHA256`, `TLS_AES_256_GCM_SHA384`, `TLS_CHACHA20_POLY1305_SHA256`, `ECDHE-RSA-AES128-GCM-SHA256`, `ECDHE-RSA-AES128-SHA256`, `ECDHE-RSA-AES256-GCM-SHA384`, `ECDHE-RSA-CHACHA20-POLY1305`, `ECDHE-RSA-AES256-SHA384`. `TLSv1` y `TLSv1.1` no son soportados.\n\n## Caché HTTP\n\nUsa las cabeceras HTTP de caché para reducir carga y ganar velocidad. La mayoría de las respuestas incluye `ETag` y/o `Last-Modified` — guarda estos valores y reenvíalos en las siguientes solicitudes vía `If-None-Match` e `If-Modified-Since`. Si el recurso no cambió, la respuesta será `304 Not Modified`, sin cuerpo y sin reprocesamiento. Más información: [HTTP Cache Docs](http://www.mnot.net/cache_docs/).\n\n## Manejo de Errores\n\nLos errores 5xx indican fallas del servidor: **500 Internal Server Error** (aplicación indisponible), **502 Bad Gateway**, **503 Service Unavailable** y **504 Gateway Timeout** (fallas puntuales de infraestructura). Tu aplicación debe identificar estos códigos y reintentar la solicitud después de algunos minutos con backoff. Estado de los servidores: [https://status.kobana.com.br](https://status.kobana.com.br).\n\n## Valores monetarios\n\nLos valores monetarios siguen dos convenciones: campos con sufijo `_cents` (÷100) y campos de precios con sufijo `_subcents` (÷10000). Usa estas convenciones para convertir a reales (BRL) antes de mostrar al usuario final.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.billing.kobana.com.br", "type": "string", "description": "https://api.billing.kobana.com.br — Producción. Sustituido en tiempo de ejecución cuando `API_V1_PUBLIC_URL` está definido.\nhttps://api.billing.sandbox.kobana.com.br — Sandbox — entorno de pruebas aislado de producción." }, { "key": "bearerToken", "value": "", "type": "string", "description": "JWT (HS512) usado no header Authorization: Bearer." } ], "item": [ { "name": "Assinaturas", "item": [ { "name": "Listar suscripciones", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions?page=1&per_page=20&sort_by=&sort_order=asc&status=draft&plan_id=00000000-0000-0000-0000-000000000000&billing_cycle=monthly&billing_account_id=00000000-0000-0000-0000-000000000000&search=&date_from=2026-01-01T00:00:00Z&date_to=2026-01-01T00:00:00Z", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "draft", "disabled": true }, { "key": "plan_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "billing_cycle", "value": "monthly", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "date_from", "value": "2026-01-01T00:00:00Z", "disabled": true }, { "key": "date_to", "value": "2026-01-01T00:00:00Z", "disabled": true } ] }, "description": "Devuelve una lista paginada de las suscripciones de la organización actual." }, "response": [] }, { "name": "Crear suscripción", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions" ] }, "body": { "mode": "raw", "raw": "{\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"plan_id\": \"00000000-0000-0000-0000-000000000000\",\n \"product_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"billing_cycle\": \"monthly\",\n \"collection_method\": \"charge_automatically\",\n \"trial_end\": \"2026-01-01T00:00:00Z\",\n \"trial_period_days\": 0,\n \"discount_code_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proration_behavior\": \"create_prorations\",\n \"nfe_issuance_policy\": \"disabled\",\n \"items\": [\n {\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 1,\n \"unit_amount_subcents\": 0\n }\n ],\n \"notes\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una suscripción. Es obligatorio enviar `plan_id` o `items`." }, "response": [] }, { "name": "Obtener suscripción", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar suscripción", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": \"00000000-0000-0000-0000-000000000000\",\n \"billing_cycle\": \"monthly\",\n \"collection_method\": \"charge_automatically\",\n \"cancel_at_period_end\": false,\n \"discount_code_id\": \"00000000-0000-0000-0000-000000000000\",\n \"discount_percent\": 0,\n \"proration_behavior\": \"create_prorations\",\n \"nfe_issuance_policy\": \"disabled\",\n \"allow_pause\": false,\n \"allow_cancel\": false,\n \"notes\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Cancelar y eliminar suscripción (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Pausar suscripción", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "pause" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"behavior\": \"mark_uncollectible\",\n \"resumes_at\": \"2026-01-01T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Suspende el cobro manteniendo la suscripción abierta. `behavior` controla cómo se tratan las facturas generadas durante la pausa." }, "response": [] }, { "name": "Reanudar suscripción pausada", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "resume" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Cancelar suscripción", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "cancel" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"cancel_at_period_end\": false,\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancela inmediatamente, o programa para el fin del período cuando `cancel_at_period_end=true`." }, "response": [] }, { "name": "Activar suscripción en borrador/confirmada", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "activate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Cambiar el plan de la suscripción", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/change-plan", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "change-plan" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"plan_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timing\": \"immediate\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Upgrade o downgrade. La prorrata sigue el `proration_behavior` de la suscripción." }, "response": [] }, { "name": "Revertir suscripción al estado confirmado", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/revert-to-confirmed", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "revert-to-confirmed" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Generar una factura puntual para la suscripción", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/create-invoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "create-invoice" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Listar ítems de la suscripción", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "items" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Resincronizar ítems con el plan actual", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscriptions/:id/sync-plan-items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "sync-plan-items" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Realinea los ítems de la suscripción con la plantilla de plan-items (reconciliación manual)." }, "response": [] } ] }, { "name": "Contas de Cobrança", "item": [ { "name": "Listar cuentas de cobro", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts?page=1&per_page=20&sort_by=&sort_order=asc&status=active&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de las cuentas de cobro de la organización actual." }, "response": [] }, { "name": "Crear cuenta de cobro", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts" ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": {\n \"id\": \"\",\n \"external_id\": \"\",\n \"document_number\": \"\",\n \"name\": \"\",\n \"nickname\": \"\",\n \"legal_name\": \"\",\n \"kind\": \"individual\",\n \"birthday\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"notes\": \"\",\n \"addresses\": {},\n \"phones\": {},\n \"emails\": {},\n \"websites\": {},\n \"tags\": [\n \"\"\n ],\n \"custom_metadata\": {}\n },\n \"external_id\": \"\",\n \"billing_email\": \"user@example.com\",\n \"payment_terms_days\": 0,\n \"auto_collection\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una cuenta de cobro asociada a un cliente. El bloque `customer` localiza un cliente existente por `id`, `external_id` o `document_number`; cuando no se encuentra, crea uno nuevo (requiere `name` y `document_number`)." }, "response": [] }, { "name": "Obtener cuenta de cobro", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar cuenta de cobro", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"address\": {},\n \"billing_email\": \"user@example.com\",\n \"payment_terms_days\": 0,\n \"auto_collection\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Cerrar cuenta de cobro", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id?reason=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id" ], "query": [ { "key": "reason", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Cierra la cuenta de cobro (equivalente a `POST /billing_accounts/{id}/close`)." }, "response": [] }, { "name": "Cerrar cuenta de cobro (POST /close)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id/close", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id", "close" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cierra la cuenta de cobro. El motivo (`reason`) se registra en el audit log." }, "response": [] }, { "name": "Suspender cuenta de cobro", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id/suspend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id", "suspend" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Suspende la cuenta. El motivo (`reason`) se registra en el audit log." }, "response": [] }, { "name": "Reactivar cuenta de cobro", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id/reactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id", "reactivate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Reactiva una cuenta de cobro suspendida." }, "response": [] }, { "name": "Listar facturas de la cuenta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id/invoices?page=1&per_page=20&sort_by=&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id", "invoices" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devuelve una lista paginada de las facturas de la cuenta de cobro." }, "response": [] }, { "name": "Listar suscripciones de la cuenta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id/subscriptions?page=1&per_page=20&sort_by=&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id", "subscriptions" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devuelve una lista paginada de las suscripciones de la cuenta de cobro." }, "response": [] }, { "name": "Listar créditos de la cuenta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/billing_accounts/:id/credits?page=1&per_page=20&sort_by=&sort_order=asc&include_expired=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "billing_accounts", ":id", "credits" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "include_expired", "value": "true", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devuelve una lista paginada de los créditos de la cuenta de cobro." }, "response": [] } ] }, { "name": "Clientes", "item": [ { "name": "Listar clientes", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers?page=1&per_page=20&sort_by=&sort_order=asc&search=&kind=natural", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "kind", "value": "natural", "disabled": true } ] }, "description": "Devuelve una lista paginada de los clientes de la organización actual." }, "response": [] }, { "name": "Crear cliente", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"external_id\": \"\",\n \"nickname\": \"\",\n \"legal_name\": \"\",\n \"document_number\": \"\",\n \"kind\": \"natural\",\n \"birthday\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"notes\": \"\",\n \"addresses\": [\n {\n \"kind\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n ],\n \"phones\": [\n {\n \"kind\": \"\",\n \"value\": \"\"\n }\n ],\n \"emails\": [\n {\n \"kind\": \"\",\n \"value\": \"\"\n }\n ],\n \"websites\": [\n {\n \"kind\": \"\",\n \"value\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ],\n \"custom_metadata\": {},\n \"create_billing_account\": false,\n \"billing_email\": \"\",\n \"payment_terms_days\": 0,\n \"auto_collection\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea un cliente y, por defecto, una cuenta de cobro asociada. Usa `create_billing_account=false` para crear solo el cliente." }, "response": [] }, { "name": "Obtener cliente", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "El parámetro `{id}` acepta el UUID del cliente o el `external_id`." }, "response": [] }, { "name": "Actualizar cliente", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"external_id\": \"\",\n \"nickname\": \"\",\n \"legal_name\": \"\",\n \"document_number\": \"\",\n \"kind\": \"natural\",\n \"birthday\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"notes\": \"\",\n \"addresses\": [\n {\n \"kind\": \"\",\n \"street\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n ],\n \"phones\": [\n {\n \"kind\": \"\",\n \"value\": \"\"\n }\n ],\n \"emails\": [\n {\n \"kind\": \"\",\n \"value\": \"\"\n }\n ],\n \"websites\": [\n {\n \"kind\": \"\",\n \"value\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "El parámetro `{id}` acepta el UUID del cliente o el `external_id`." }, "response": [] }, { "name": "Eliminar cliente (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Marca el cliente como eliminado sin borrar registros históricos." }, "response": [] }, { "name": "Listar extracto financiero del cliente", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/statement?page=1&per_page=20&sort_by=&sort_order=asc&billing_account_id=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "statement" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Devuelve los movimientos del extracto (facturas, pagos, aplicaciones de crédito) de la cuenta de cobro del cliente. Cuando el cliente tiene múltiples cuentas, informa `billing_account_id`." }, "response": [] }, { "name": "Reconstruir el extracto a partir del historial", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/statement/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "statement", "sync" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Recrea los ítems del extracto a partir de las facturas, pagos y aplicaciones de crédito existentes. Devuelve el resumen de lo creado." }, "response": [] }, { "name": "Recalcular el MRR del cliente", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/recalculate-mrr", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "recalculate-mrr" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Recalcula el MRR (Monthly Recurring Revenue) de las cuentas de cobro del cliente a partir de las suscripciones activas." }, "response": [] }, { "name": "Listar usuarios del portal del cliente", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users?page=1&per_page=20&sort_by=&sort_order=asc&status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Devuelve los usuarios con acceso al portal vinculados a la cuenta de cobro del cliente." }, "response": [] }, { "name": "Invitar usuario del portal", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una invitación de acceso al portal para el correo informado. La invitación expira en 7 días." }, "response": [] }, { "name": "Invitar usuario del portal (verbo)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users", "invite" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Equivalente a `POST /customers/{id}/users`. Disponible como ruta de verbo para SDKs que prefieren URLs descriptivas." }, "response": [] }, { "name": "Obtener usuario del portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users", ":user_id" ], "variable": [ { "key": "id", "value": "" }, { "key": "user_id", "value": "" } ] }, "description": "El parámetro `{user_id}` acepta el UUID o el `external_id` del usuario." }, "response": [] }, { "name": "Actualizar usuario del portal", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users", ":user_id" ], "variable": [ { "key": "id", "value": "" }, { "key": "user_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"external_id\": \"\",\n \"sso_only\": false,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza `email`, `external_id`, `sso_only` y `status`. Transiciones de estado permitidas: `active` ↔ `suspended`." }, "response": [] }, { "name": "Eliminar usuario del portal", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users", ":user_id" ], "variable": [ { "key": "id", "value": "" }, { "key": "user_id", "value": "" } ] }, "description": "Las invitaciones pendientes se eliminan definitivamente; los usuarios activos se suspenden." }, "response": [] }, { "name": "Previsualizar correo del usuario del portal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users/:user_id/email-preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users", ":user_id", "email-preview" ], "variable": [ { "key": "id", "value": "" }, { "key": "user_id", "value": "" } ] }, "description": "Devuelve el asunto y el mensaje del correo de invitación o verificación que se enviaría al usuario, sin disparar el envío. Disponible solo para usuarios `pending_invitation` o `pending_verification`." }, "response": [] }, { "name": "Reenviar correo de invitación o verificación", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:id/users/:user_id/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":id", "users", ":user_id", "resend" ], "variable": [ { "key": "id", "value": "" }, { "key": "user_id", "value": "" } ] }, "description": "Reenvía el correo de invitación (para `pending_invitation`, con rotación de token) o de verificación (para `pending_verification`). Otros estados devuelven 400." }, "response": [] } ] }, { "name": "Planos", "item": [ { "name": "Listar planes", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans?page=1&per_page=20&sort_by=&sort_order=asc&status=draft&plan_type=standard&visibility=public&plan_group_id=00000000-0000-0000-0000-000000000000&company_id=00000000-0000-0000-0000-000000000000&billing_account_id=00000000-0000-0000-0000-000000000000&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "draft", "disabled": true }, { "key": "plan_type", "value": "standard", "disabled": true }, { "key": "visibility", "value": "public", "disabled": true }, { "key": "plan_group_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de los planes de la organización actual." }, "response": [] }, { "name": "Crear plan", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans" ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"plan_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"plan_type\": \"standard\",\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"visibility\": \"public\",\n \"features\": [\n \"\"\n ],\n \"limits\": {\n \"users\": 0,\n \"subaccounts\": 0,\n \"operationsPerMonth\": 0,\n \"apiRequestsPerDay\": 0\n },\n \"trial_period_days\": 0,\n \"default_billing_cycle\": \"monthly\",\n \"available_billing_cycles\": [\n \"monthly\"\n ],\n \"items\": [\n {\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 1,\n \"included\": true\n }\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea un plan para la organización autenticada." }, "response": [] }, { "name": "Obtener plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar plan", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"plan_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"plan_type\": \"standard\",\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"visibility\": \"public\",\n \"features\": [\n \"\"\n ],\n \"limits\": {\n \"users\": 0,\n \"subaccounts\": 0,\n \"operationsPerMonth\": 0,\n \"apiRequestsPerDay\": 0\n },\n \"trial_period_days\": 0,\n \"default_billing_cycle\": \"monthly\",\n \"available_billing_cycles\": [\n \"monthly\"\n ],\n \"items\": [\n {\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 1,\n \"included\": true\n }\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archivar o eliminar plan", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/:id?hard=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", ":id" ], "query": [ { "key": "hard", "value": "false", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Por defecto archiva el plan (soft delete). Usa `?hard=true` para eliminar permanentemente un plan en borrador." }, "response": [] }, { "name": "Duplicar plan", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Crea una copia del plan (incluyendo sus ítems) en estado de borrador." }, "response": [] }, { "name": "Listar ítems del plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", ":id", "items" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Reemplazar ítems del plan", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", ":id", "items" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 1,\n \"included\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Reemplaza de forma atómica todos los ítems del plan. Solo se aceptan productos raíz y cada `product_id` debe ser único en la lista." }, "response": [] }, { "name": "Archivar planes en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/bulk-archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", "bulk-archive" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Eliminar planes en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/bulk-delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", "bulk-delete" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Elimina permanentemente los planes informados. Los planes con suscripciones activas se omiten y se devuelven en `skipped_ids`." }, "response": [] }, { "name": "Mover planes a otro grupo en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plans/bulk-move-group", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plans", "bulk-move-group" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"plan_group_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Grupos de Plano", "item": [ { "name": "Listar grupos de planes", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_groups?search=&include_archived=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_groups" ], "query": [ { "key": "search", "value": "", "disabled": true }, { "key": "include_archived", "value": "true", "disabled": true } ] }, "description": "Devuelve todos los grupos de planes de la organización actual ordenados por `display_order`." }, "response": [] }, { "name": "Crear grupo de planes", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_groups" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Obtener grupo de planes", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar grupo de planes", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Eliminar grupo de planes", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Reordenar grupos de planes", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_groups/reorder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_groups", "reorder" ] }, "body": { "mode": "raw", "raw": "{\n \"group_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza el `display_order` de los grupos según el orden del array `group_ids`. Todos los grupos deben pertenecer a la organización actual." }, "response": [] }, { "name": "Archivar grupo de planes", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_groups/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_groups", ":id", "archive" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Marca el grupo como archivado completando `archived_at`. Los grupos archivados se ocultan de los listados por defecto." }, "response": [] } ] }, { "name": "Produtos", "item": [ { "name": "Listar productos", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products?page=1&per_page=20&sort_by=&sort_order=asc&status=all&visibility=public&productType=base&productGroupId=00000000-0000-0000-0000-000000000000&companyId=00000000-0000-0000-0000-000000000000&parentProductId=00000000-0000-0000-0000-000000000000&rootOnly=false&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "all", "disabled": true }, { "key": "visibility", "value": "public", "disabled": true }, { "key": "productType", "value": "base", "disabled": true }, { "key": "productGroupId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "companyId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "parentProductId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "rootOnly", "value": "false", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de los productos de la organización actual." }, "response": [] }, { "name": "Crear producto", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"productType\": \"base\",\n \"visibility\": \"public\",\n \"unitLabel\": \"\",\n \"increment\": 0,\n \"websiteUrl\": \"https://example.com\",\n \"isRequired\": false,\n \"parentProductId\": \"00000000-0000-0000-0000-000000000000\",\n \"productGroupId\": \"00000000-0000-0000-0000-000000000000\",\n \"companyId\": \"00000000-0000-0000-0000-000000000000\",\n \"customMetadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Obtener producto", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar producto", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"status\": \"draft\",\n \"productType\": \"base\",\n \"visibility\": \"public\",\n \"unitLabel\": \"\",\n \"increment\": 0,\n \"websiteUrl\": \"https://example.com\",\n \"isRequired\": false,\n \"parentProductId\": \"00000000-0000-0000-0000-000000000000\",\n \"productGroupId\": \"00000000-0000-0000-0000-000000000000\",\n \"companyId\": \"00000000-0000-0000-0000-000000000000\",\n \"customMetadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archivar producto (soft delete)", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Archiva el producto. Devuelve 422 cuando el producto está en uso por suscripciones activas." }, "response": [] }, { "name": "Archivar producto", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":id", "archive" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Archiva el producto. Devuelve 422 cuando el producto está en uso por suscripciones activas o ya está archivado." }, "response": [] }, { "name": "Publicar producto", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/:id/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":id", "publish" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Promueve un producto en borrador al estado activo." }, "response": [] }, { "name": "Restaurar producto archivado", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", ":id", "restore" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Restaura un producto archivado al estado activo." }, "response": [] }, { "name": "Reordenar productos", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/reorder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", "reorder" ] }, "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza el orden de visualización de los productos. El índice 0 del array pasa a ser el primer ítem de la lista." }, "response": [] }, { "name": "Reordenar productos (PUT /reorder)", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/reorder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", "reorder" ] }, "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Alias `PUT` para `/products/reorder`. Mismo comportamiento que la versión `POST`." }, "response": [] }, { "name": "Archivar productos en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/bulk-archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", "bulk-archive" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Archiva múltiples productos. Los IDs en uso por suscripciones activas o ya archivados se ignoran y se reportan en la respuesta." }, "response": [] }, { "name": "Eliminar productos en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/bulk-delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", "bulk-delete" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Elimina permanentemente múltiples productos. Los IDs en uso por suscripciones activas se ignoran y se reportan en la respuesta." }, "response": [] }, { "name": "Cambiar visibilidad en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/bulk-visibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", "bulk-visibility" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"visibility\": \"public\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza la visibilidad (`public` o `private`) de múltiples productos." }, "response": [] }, { "name": "Mover productos a otro grupo", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/bulk-move-group", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", "bulk-move-group" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"product_group_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Mueve múltiples productos a un grupo de productos. Envía `product_group_id: null` para quitarlos del grupo actual." }, "response": [] }, { "name": "Cambiar empresa de productos en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/products/bulk-change-company", "host": [ "{{baseUrl}}" ], "path": [ "v1", "products", "bulk-change-company" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"company_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Reasigna múltiples productos a otra empresa. Envía `company_id: null` para limpiar el vínculo." }, "response": [] } ] }, { "name": "Grupos de Produto", "item": [ { "name": "Listar grupos de productos", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups?page=1&per_page=20&sort_by=&sort_order=asc&search=&company_id=00000000-0000-0000-0000-000000000000&include_archived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "include_archived", "value": "false", "disabled": true } ] }, "description": "Devuelve una lista paginada de los grupos de productos de la organización actual." }, "response": [] }, { "name": "Crear grupo de productos", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proposal_template_id\": \"00000000-0000-0000-0000-000000000000\",\n \"service_item_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Obtener grupo de productos", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar grupo de productos", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"proposal_template_id\": \"00000000-0000-0000-0000-000000000000\",\n \"service_item_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Eliminar grupo de productos", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Archivar grupo de productos", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups", ":id", "archive" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Desarchivar grupo de productos", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups", ":id", "archive" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Reordenar grupos de productos", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups/reorder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups", "reorder" ] }, "body": { "mode": "raw", "raw": "{\n \"group_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza el orden de visualización de los grupos de productos. El array `group_ids` define el nuevo orden — el índice 0 pasa a ser el primer grupo." }, "response": [] }, { "name": "Reordenar grupos de productos (alias PUT)", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/product_groups/reorder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "product_groups", "reorder" ] }, "body": { "mode": "raw", "raw": "{\n \"group_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Alias `PUT` para `POST /product_groups/reorder`. Mismo contrato." }, "response": [] } ] }, { "name": "Organização", "item": [ { "name": "Obtener organización actual", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/organization", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organization" ] }, "description": "Devuelve los datos de la organización a la que pertenece el token autenticado. No hay parámetro `:id` — la organización siempre se resuelve a partir de la clave de la API." }, "response": [] }, { "name": "Actualizar organización actual", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/organization", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organization" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"addresses\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza el perfil de la organización autenticada. Solo los campos a continuación pueden modificarse — la identidad (`id`, `external_id`, `status`) no es modificable por este endpoint." }, "response": [] } ] }, { "name": "Empresas", "item": [ { "name": "Listar empresas", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies?page=1&per_page=20&sort_by=&sort_order=asc&status=active&search=&is_default=true&parent_company_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_default", "value": "true", "disabled": true }, { "key": "parent_company_id", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de las empresas (matrices y sucursales) de la organización actual." }, "response": [] }, { "name": "Crear empresa", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ] }, "body": { "mode": "raw", "raw": "{\n \"parent_company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"legal_name\": \"\",\n \"document_type\": \"cpf\",\n \"document_number\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"addresses\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"phones\": [\n {}\n ],\n \"websites\": [\n {}\n ],\n \"is_default\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una empresa (matriz o sucursal). Para crear una sucursal, informa `parent_company_id` — el CNPJ debe compartir el mismo prefijo que la matriz. Solo las empresas con CNPJ pueden tener sucursales. La primera empresa creada en la organización se marca como `is_default` automáticamente." }, "response": [] }, { "name": "Listar matrices", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/matriz", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", "matriz" ] }, "description": "Lista las empresas matrices (sin `parent_company_id`) activas de la organización. Útil para seleccionar la matriz al crear una sucursal. Solo aparecen empresas con CNPJ." }, "response": [] }, { "name": "Obtener empresa", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar empresa", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"legal_name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"addresses\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"phones\": [\n {}\n ],\n \"websites\": [\n {}\n ],\n \"is_default\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Desactivar empresa", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Desactiva la empresa (soft delete — equivalente a `POST /companies/{id}/deactivate`). No es posible desactivar la única empresa activa ni una empresa con suscripciones activas o en período de prueba." }, "response": [] }, { "name": "Definir empresa por defecto", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id/set-default", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id", "set-default" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Marca la empresa como predeterminada de la organización. La empresa predeterminada anterior se desmarca en la misma transacción." }, "response": [] }, { "name": "Desactivar empresa (POST /deactivate)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id", "deactivate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Desactiva la empresa. No es posible desactivar la única empresa activa ni una empresa con suscripciones activas o en período de prueba. Si la empresa desactivada era la predeterminada, otra empresa activa se promueve automáticamente." }, "response": [] }, { "name": "Reactivar empresa", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id/reactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id", "reactivate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Reactiva una empresa previamente desactivada. Devuelve **422** cuando la empresa ya está activa." }, "response": [] }, { "name": "Obtener perfil fiscal", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id/fiscal", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id", "fiscal" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devuelve el perfil fiscal de la empresa, o `null` cuando aún no se ha configurado." }, "response": [] }, { "name": "Actualizar perfil fiscal", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id/fiscal", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id", "fiscal" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"taxation_regime\": \"simple_national\",\n \"simples_annex\": \"annex_iii\",\n \"rbt12_cents\": 0,\n \"factor_r\": 0,\n \"cpp_inside_das\": false,\n \"presumption_rate\": 0,\n \"iss_municipality\": \"\",\n \"iss_rate\": 0,\n \"pis_rate\": 0,\n \"cofins_rate\": 0,\n \"csll_rate\": 0,\n \"irpj_rate\": 0,\n \"cbs_ibs_enabled\": false,\n \"cbs_rate\": 0,\n \"ibs_rate\": 0,\n \"cbs_ibs_mode\": \"informative\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea o actualiza (upsert) el perfil fiscal de la empresa. Incluye régimen tributario, alícuotas (ISS, PIS, COFINS, CSLL, IRPJ) y configuración de CBS/IBS." }, "response": [] }, { "name": "Obtener perfil fiscal (alias)", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id/fiscal-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id", "fiscal-profile" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Alias de `GET /companies/{id}/fiscal` — misma representación y comportamiento." }, "response": [] }, { "name": "Actualizar perfil fiscal (alias)", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:id/fiscal-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":id", "fiscal-profile" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"taxation_regime\": \"simple_national\",\n \"simples_annex\": \"annex_iii\",\n \"rbt12_cents\": 0,\n \"factor_r\": 0,\n \"cpp_inside_das\": false,\n \"presumption_rate\": 0,\n \"iss_municipality\": \"\",\n \"iss_rate\": 0,\n \"pis_rate\": 0,\n \"cofins_rate\": 0,\n \"csll_rate\": 0,\n \"irpj_rate\": 0,\n \"cbs_ibs_enabled\": false,\n \"cbs_rate\": 0,\n \"ibs_rate\": 0,\n \"cbs_ibs_mode\": \"informative\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Alias de `PATCH /companies/{id}/fiscal` — misma representación y comportamiento." }, "response": [] } ] }, { "name": "Certificados", "item": [ { "name": "Listar certificados digitales", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/certificates?page=1&per_page=20&sort_by=&sort_order=asc&status=active&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "certificates" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de los certificados digitales (A1) de la organización actual. Por seguridad, la respuesta **nunca** incluye la clave privada ni la contraseña del PFX — solo metadatos extraídos del certificado." }, "response": [] }, { "name": "Subir certificado digital", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/certificates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "certificates" ] }, "description": "Sube un certificado digital A1 vía `multipart/form-data`. La clave privada y la contraseña se cifran en reposo y **nunca** son devueltas por la API. El endpoint detecta duplicados por `thumbprint` y asocia automáticamente el certificado a un `person` por el CNPJ/CPF extraído.\n\nValores aceptados para `type`:\n- `pfx` — enviar `file` (PFX/P12 binario) y `password`.\n- `cert_key` — enviar `cert_file` (PEM del certificado) y `key_file` (PEM de la clave).\n- `combined_pem` — enviar `file` (PEM con certificado + clave).\n- `cert_key_password` — enviar `cert_file`, `key_file` y `password` (clave protegida por contraseña)." }, "response": [] }, { "name": "Obtener certificado", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "certificates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Eliminar certificado", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "certificates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina el certificado mediante **soft delete**. Los datos cifrados permanecen en la base solo para fines de auditoría." }, "response": [] } ] }, { "name": "Cupons", "item": [ { "name": "Listar cupones", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/coupons?page=1&per_page=20&sort_by=&sort_order=asc&is_active=true&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "is_active", "value": "true", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de los cupones de la organización actual." }, "response": [] }, { "name": "Crear cupón", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/coupons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons" ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"discount_type\": \"percentage\",\n \"discount_value\": 0,\n \"currency\": \"\",\n \"min_purchase_cents\": 0,\n \"max_discount_cents\": 0,\n \"usage_limit\": 0,\n \"usage_limit_per_user\": 0,\n \"valid_from\": \"\",\n \"valid_until\": \"\",\n \"applies_to\": {\n \"planIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"productIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n },\n \"excludes\": {},\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea un cupón de descuento. El `code` debe ser único por organización. Usa `discount_type=percentage` con `discount_value` entre `0` y `100`, o `discount_type=fixed_amount` con `discount_value` en centavos (÷100 → BRL)." }, "response": [] }, { "name": "Obtener cupón", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/coupons/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar cupón", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/coupons/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"usage_limit\": 0,\n \"usage_limit_per_user\": 0,\n \"valid_from\": \"\",\n \"valid_until\": \"\",\n \"applies_to\": {\n \"planIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"productIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n },\n \"excludes\": {},\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza campos editables del cupón. `code`, `discount_type`, `discount_value` y `currency` son inmutables después de la creación." }, "response": [] }, { "name": "Eliminar cupón", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/coupons/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina el cupón permanentemente. Solo se permite mientras el cupón **no tenga canjes registrados** — de lo contrario, usa `POST /coupons/{id}/deactivate` para preservar el historial." }, "response": [] }, { "name": "Desactivar cupón", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/coupons/:id/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":id", "deactivate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Desactiva el cupón: los nuevos canjes quedan bloqueados, pero los canjes anteriores se preservan." }, "response": [] }, { "name": "Listar canjes del cupón", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/coupons/:id/redemptions?page=1&per_page=20&sort_by=&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "coupons", ":id", "redemptions" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devuelve una lista paginada de los canjes registrados para el cupón." }, "response": [] } ] }, { "name": "Créditos", "item": [ { "name": "Listar créditos", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/credits?page=1&per_page=20&sort_by=&sort_order=asc&billing_account_id=00000000-0000-0000-0000-000000000000&company_id=00000000-0000-0000-0000-000000000000&type=promotional&usage=available&include_expired=true&date_from=2026-01-01T00:00:00Z&date_to=2026-01-01T00:00:00Z", "host": [ "{{baseUrl}}" ], "path": [ "v1", "credits" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "type", "value": "promotional", "disabled": true }, { "key": "usage", "value": "available", "disabled": true }, { "key": "include_expired", "value": "true", "disabled": true }, { "key": "date_from", "value": "2026-01-01T00:00:00Z", "disabled": true }, { "key": "date_to", "value": "2026-01-01T00:00:00Z", "disabled": true } ] }, "description": "Devuelve una lista paginada de los créditos de la organización actual. Por defecto, los créditos expirados se omiten — usa `usage` o `include_expired` para incluirlos." }, "response": [] }, { "name": "Agregar crédito", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/credits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "credits" ] }, "body": { "mode": "raw", "raw": "{\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"promotional\",\n \"amount_cents\": 10000,\n \"description\": \"\",\n \"expires_at\": \"2026-01-01T00:00:00Z\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Agrega un crédito a una cuenta de cobro. El monto se acredita en `balance_cents` de la `BillingAccount` y queda disponible para descontar facturas futuras. Cuando se informa `company_id`, el crédito solo puede aplicarse a facturas de la misma `company`." }, "response": [] }, { "name": "Obtener crédito", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/credits/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "credits", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar crédito", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/credits/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "credits", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"promotional\",\n \"amount_cents\": 0,\n \"description\": \"\",\n \"expires_at\": \"2026-01-01T00:00:00Z\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Ajusta el crédito (tipo, monto, descripción o fecha de expiración). `amount_cents` solo puede cambiarse si el crédito no ha sido parcialmente utilizado — de lo contrario la API responde `400`." }, "response": [] }, { "name": "Eliminar crédito", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/credits/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "credits", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina el crédito y revierte el saldo correspondiente en la cuenta de cobro. Solo se permite si no se ha consumido ningún centavo del crédito — de lo contrario la API responde `400`." }, "response": [] } ] }, { "name": "Faturas", "item": [ { "name": "Listar facturas", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices?page=1&per_page=20&sort_by=&sort_order=asc&status=draft&billing_account_id=00000000-0000-0000-0000-000000000000&company_id=00000000-0000-0000-0000-000000000000&subscription_id=00000000-0000-0000-0000-000000000000&due_date_from=&due_date_to=&date_from=&date_to=&search=&total_cents=0&document_number=&without_payments=true&plan_filter=all", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "draft", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "subscription_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "due_date_from", "value": "", "disabled": true }, { "key": "due_date_to", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "total_cents", "value": "0", "disabled": true }, { "key": "document_number", "value": "", "disabled": true }, { "key": "without_payments", "value": "true", "disabled": true }, { "key": "plan_filter", "value": "all", "disabled": true } ] }, "description": "Devuelve una lista paginada de las facturas de la organización actual." }, "response": [] }, { "name": "Crear factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices" ] }, "body": { "mode": "raw", "raw": "{\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"subscription_id\": \"00000000-0000-0000-0000-000000000000\",\n \"product_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"collection_method\": \"charge_automatically\",\n \"due_date\": \"\",\n \"description\": \"\",\n \"footer\": \"\",\n \"line_items\": [\n {\n \"description\": \"\",\n \"quantity\": 0,\n \"unit_amount_cents\": 0,\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"service_item_id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"discount_cents\": 0,\n \"discount_description\": \"\",\n \"installments\": [\n {\n \"amount_cents\": 0,\n \"due_date\": \"\"\n }\n ],\n \"nfe_issuance_policy\": \"disabled\",\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una factura para una cuenta de cobro. Acepta ítems de línea, parcelas opcionales (`installments`, mínimo 2) y política de emisión de NF-e." }, "response": [] }, { "name": "Listar facturas con pago pendiente", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/pending-payment?page=1&per_page=20&sort_by=&sort_order=asc&billing_account_id=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", "pending-payment" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true } ] }, "description": "Devuelve facturas finalizadas (`status = open`) cuya `due_date` ya pasó." }, "response": [] }, { "name": "Listar facturas con NF-e pendiente", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/pending-nfe?page=1&per_page=20&sort_by=&sort_order=asc&billing_account_id=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", "pending-nfe" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true } ] }, "description": "Devuelve facturas pagadas pero con emisión de NF-e pendiente — sin NF-e, o con NF-e en estado `pending`, `processing` o `error`." }, "response": [] }, { "name": "Obtener factura", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar factura", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"collection_method\": \"charge_automatically\",\n \"due_date\": \"\",\n \"description\": \"\",\n \"footer\": \"\",\n \"line_items\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"description\": \"\",\n \"quantity\": 0,\n \"unit_amount_cents\": 0\n }\n ],\n \"nfe_issuance_policy\": \"disabled\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Eliminar factura", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina una factura en borrador (`draft`). Las facturas finalizadas deben cancelarse vía `POST /invoices/{id}/void`." }, "response": [] }, { "name": "Finalizar factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/finalize", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "finalize" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Finaliza una factura en borrador (`draft` → `open`)." }, "response": [] }, { "name": "Cancelar (void) factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/void", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "void" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancela una factura abierta (`open` → `void`). El motivo (`reason`) se registra en el audit log." }, "response": [] }, { "name": "Deshacer pago de la factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/undo-payment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "undo-payment" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Revierte el pago de la factura (`paid` → `open`). El motivo (`reason`) se registra en el audit log." }, "response": [] }, { "name": "Pagar factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/pay", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "pay" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"pix\",\n \"payment_method_id\": \"00000000-0000-0000-0000-000000000000\",\n \"card\": {\n \"card_token\": \"\",\n \"holder_name\": \"\"\n },\n \"amount_cents\": 0,\n \"installment_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Dos modos: (a) cuando se informa `payment_method`, crea un pago vía gateway (`pix`, `bank_slip` o `card`) y devuelve los artefactos del método (QR code, código de barras o estado de la tarjeta); (b) cuando se omite, marca la factura como pagada manualmente (reconciliación)." }, "response": [] }, { "name": "Enviar recordatorio de cobro", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/send-reminder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "send-reminder" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Envía por correo un recordatorio de cobro de la factura al `billing_email` de la cuenta." }, "response": [] }, { "name": "Emitir NF-e para la factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/issue-nfe", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "issue-nfe" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Dispara la emisión de la NF-e (Factura Electrónica) para la factura." }, "response": [] }, { "name": "Aplicar créditos a la factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/apply-credits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "apply-credits" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"credit_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"amount_cents\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Aplica créditos de la cuenta de cobro en una factura abierta (`status = open`)." }, "response": [] }, { "name": "Eliminar créditos aplicados", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/remove-credits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "remove-credits" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina todos los créditos aplicados a la factura, devolviéndolos a la cuenta de cobro. Solo funciona en facturas abiertas (`status = open`)." }, "response": [] }, { "name": "Descargar PDF de la factura", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "pdf" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Genera y descarga el PDF de la factura como adjunto binario (`application/pdf`)." }, "response": [] }, { "name": "Listar métodos de pago disponibles", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/payment-methods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "payment-methods" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Lista los métodos de pago disponibles para pagar esta factura, según los gateways activos de la organización y la configuración del portal." }, "response": [] }, { "name": "Listar parcelas de la factura", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/installments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "installments" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Crear/actualizar cronograma de parcelas", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/installments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "installments" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"installments\": [\n {\n \"amount_cents\": 0,\n \"due_date\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea o reemplaza el cronograma de parcelas de la factura. Mínimo de 2 parcelas." }, "response": [] }, { "name": "Marcar parcela como pagada", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/installments/:installmentId/mark-paid", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "installments", ":installmentId", "mark-paid" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "installmentId", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Marca manualmente una parcela como pagada (reconciliación, sin llamada al gateway)." }, "response": [] }, { "name": "Pagar parcela", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:id/installments/:installmentId/pay", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":id", "installments", ":installmentId", "pay" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "installmentId", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"pix\",\n \"payment_method_id\": \"00000000-0000-0000-0000-000000000000\",\n \"card\": {\n \"card_token\": \"\",\n \"holder_name\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Procesa el pago de una parcela vía gateway. La parcela anterior debe estar pagada." }, "response": [] } ] }, { "name": "Pagamentos", "item": [ { "name": "Listar pagos", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments?page=1&per_page=20&sort_by=&sort_order=asc&status=pending&invoiceId=00000000-0000-0000-0000-000000000000&billingAccountId=00000000-0000-0000-0000-000000000000&dateFrom=&dateTo=&paidDateFrom=&paidDateTo=&invoiceFilter=all&paymentMethodType=card&amountMinCents=0&amountMaxCents=0&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "pending", "disabled": true }, { "key": "invoiceId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "billingAccountId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "dateFrom", "value": "", "disabled": true }, { "key": "dateTo", "value": "", "disabled": true }, { "key": "paidDateFrom", "value": "", "disabled": true }, { "key": "paidDateTo", "value": "", "disabled": true }, { "key": "invoiceFilter", "value": "all", "disabled": true }, { "key": "paymentMethodType", "value": "card", "disabled": true }, { "key": "amountMinCents", "value": "0", "disabled": true }, { "key": "amountMaxCents", "value": "0", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de los pagos de la organización actual." }, "response": [] }, { "name": "Procesar pago", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments" ] }, "body": { "mode": "raw", "raw": "{\n \"invoiceId\": \"00000000-0000-0000-0000-000000000000\",\n \"paymentMethodId\": \"00000000-0000-0000-0000-000000000000\",\n \"paymentMethod\": {\n \"type\": \"card\",\n \"card\": {\n \"cardToken\": \"\",\n \"number\": \"\",\n \"expMonth\": 0,\n \"expYear\": 0,\n \"cvv\": \"\",\n \"holderName\": \"\"\n }\n },\n \"amountCents\": 0,\n \"customMetadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Procesa un pago para una factura existente. Acepta un `payment_method_id` previamente registrado **o** un bloque `payment_method` con datos de tarjeta/PIX/boleto. Cuando se omite `amount_cents`, cobra el saldo abierto de la factura." }, "response": [] }, { "name": "Reasignar pagos a otra factura", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/bulk-update-invoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", "bulk-update-invoice" ] }, "body": { "mode": "raw", "raw": "{\n \"payment_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"invoice_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza en bloque la factura asociada a los pagos indicados. Útil para corregir vínculos cuando los pagos llegaron apuntando a la factura equivocada." }, "response": [] }, { "name": "Obtener pago", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Eliminar pago", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina un pago. Los pagos ya confirmados no pueden eliminarse — use `cancel` o `refund`." }, "response": [] }, { "name": "Cancelar pago", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "cancel" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\",\n \"cancel_on_gateway\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancela un pago abierto. Cuando `cancel_on_gateway` es `true` (por defecto), la cancelación se propaga al gateway." }, "response": [] }, { "name": "Reintentar pago", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/retry", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "retry" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"card\": {\n \"cardToken\": \"\",\n \"holderName\": \"\"\n },\n \"payment_method_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Reprocesa un pago fallido. Opcionalmente cambia a una tarjeta nueva (vía `card`) o a un medio de pago guardado (`payment_method_id`)." }, "response": [] }, { "name": "Cambiar tarjeta del pago", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/change-card", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "change-card" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"credit_card_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Reemplaza la tarjeta de crédito de un pago fallido procesado por Pagar.me. La nueva tarjeta debe estar registrada previamente en `payment_methods`." }, "response": [] }, { "name": "Cambiar vencimiento del boleto", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/change-due-date", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "change-due-date" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"due_date\": \"2026-08-15\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cambia el vencimiento de un pago en boleto pendiente emitido vía gateway Kobana. La nueva fecha debe ser futura." }, "response": [] }, { "name": "Enviar boleto por correo", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/send-email", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "send-email" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"message\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Envía el enlace del boleto por correo al destinatario indicado. Disponible solo para pagos en boleto pendientes." }, "response": [] }, { "name": "Sincronizar pago con el gateway", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "sync" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Sincroniza el estado del pago con el gateway upstream (PIX/boleto Kobana o reembolso Pagar.me). Devuelve el pago actualizado." }, "response": [] }, { "name": "Reembolsar pago", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/refund", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "refund" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount_cents\": 0,\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Reembolsa un pago exitoso. Sin `amount_cents`, reembolsa el monto total; con un monto parcial, emite un reembolso parcial." }, "response": [] } ] }, { "name": "Métodos de Pagamento", "item": [ { "name": "Listar métodos de pago", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payment_methods?page=1&per_page=20&sort_by=&sort_order=asc&billingAccountId=00000000-0000-0000-0000-000000000000&type=card&status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_methods" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "billingAccountId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "type", "value": "card", "disabled": true }, { "key": "status", "value": "active", "disabled": true } ] }, "description": "Devuelve una lista paginada de los métodos de pago de la organización actual. Filtros opcionales: `billing_account_id`, `type`, `status`." }, "response": [] }, { "name": "Crear método de pago", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_methods" ] }, "body": { "mode": "raw", "raw": "{\n \"billingAccountId\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"card\",\n \"isDefault\": false,\n \"card\": {\n \"cardToken\": \"\",\n \"holderName\": \"\"\n },\n \"bankAccount\": {\n \"bankCode\": \"341\",\n \"agency\": \"\",\n \"account\": \"\",\n \"accountType\": \"checking\",\n \"holderName\": \"\",\n \"holderDocument\": \"\"\n },\n \"billingDetails\": {\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"address\": {\n \"street\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea un método de pago asociado a una cuenta de cobro. Para `type=card`, envía el bloque `card` con el `cardToken` generado por la tokenización del lado del cliente. Para `type=bank_transfer`, envía el bloque `bankAccount`. Para `bank_slip` y `pix`, basta con el `type` — el gateway predeterminado se resuelve por la organización." }, "response": [] }, { "name": "Obtener método de pago", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payment_methods/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_methods", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar vencimiento de la tarjeta", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payment_methods/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_methods", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"exp_month\": 0,\n \"exp_year\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza solo el mes y año de vencimiento de la tarjeta asociada al método. Falla cuando `type` no es `card`." }, "response": [] }, { "name": "Eliminar método de pago", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payment_methods/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_methods", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Soft delete del método de pago (lo marca como `removed`). Falla cuando hay pagos pendientes o en procesamiento. Si era el predeterminado, otro método activo se promueve automáticamente." }, "response": [] }, { "name": "Definir método como predeterminado", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/payment_methods/:id/set-default", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_methods", ":id", "set-default" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Marca el método como predeterminado de la cuenta de cobro y desmarca los anteriores. Falla cuando el método no está `active`." }, "response": [] } ] }, { "name": "NF-e", "item": [ { "name": "Listar NF-e", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes?page=1&per_page=20&sort_by=&sort_order=asc&billingAccountId=00000000-0000-0000-0000-000000000000&companyId=00000000-0000-0000-0000-000000000000&invoiceId=00000000-0000-0000-0000-000000000000&status=draft&invoiceFilter=with&dateFrom=&dateTo=&issueDateFrom=&issueDateTo=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "billingAccountId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "companyId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "invoiceId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "status", "value": "draft", "disabled": true }, { "key": "invoiceFilter", "value": "with", "disabled": true }, { "key": "dateFrom", "value": "", "disabled": true }, { "key": "dateTo", "value": "", "disabled": true }, { "key": "issueDateFrom", "value": "", "disabled": true }, { "key": "issueDateTo", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de NF-e (facturas electrónicas) de la organización actual." }, "response": [] }, { "name": "Crear NF-e (borrador)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes" ] }, "body": { "mode": "raw", "raw": "{\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"invoice_id\": \"00000000-0000-0000-0000-000000000000\",\n \"transaction_id\": \"00000000-0000-0000-0000-000000000000\",\n \"amount_cents\": 0,\n \"service_code\": \"\",\n \"service_description\": \"\",\n \"lc116_code\": \"\",\n \"cnae_code\": \"\",\n \"nbs_code\": \"\",\n \"rps_number\": 0,\n \"rps_serial_number\": \"\",\n \"customer\": {\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"document_type\": \"cpf\",\n \"document_number\": \"\",\n \"phone\": \"\",\n \"address\": {\n \"street\": \"\",\n \"number\": \"\",\n \"complement\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"city_code\": \"\",\n \"state\": \"\",\n \"zip_code\": \"\",\n \"country\": \"\"\n }\n },\n \"taxes\": {\n \"iss_rate\": 0,\n \"pis_rate\": 0,\n \"cofins_rate\": 0,\n \"csll_rate\": 0,\n \"ir_rate\": 0,\n \"inss_rate\": 0\n },\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una NF-e en borrador (`draft`) para emisión posterior vía `POST /nfes/{id}/issue`. Acepta datos del tomador (`customer`) y alícuotas opcionales." }, "response": [] }, { "name": "Sincronizar NF-e de la organización", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "sync" ] }, "description": "Dispara un job en background para sincronizar todas las NF-e de la organización con el proveedor (actualiza estado, descarga PDFs/XMLs pendientes). Devuelve el `job_id` para seguimiento. Rechaza si ya hay una sync activa." }, "response": [] }, { "name": "Actualizar NF-e en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "bulk" ] }, "body": { "mode": "raw", "raw": "{\n \"nfe_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"invoice_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza varias NF-e a la vez. Hoy soporta vincular o desvincular una factura (`invoice_id`) en hasta 100 NF-e por solicitud." }, "response": [] }, { "name": "Eliminar NF-e en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/bulk-delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "bulk-delete" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Elimina hasta 100 NF-e a la vez. Todas deben estar en estado `draft` y pertenecer a la organización actual." }, "response": [] }, { "name": "Listar reintentos de solicitud (organización)", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/request-tries?page=1&per_page=20&sort_by=&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "request-tries" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true } ] }, "description": "Lista todos los intentos de solicitud al proveedor de NF-e de la organización, paginados y ordenados por fecha descendente." }, "response": [] }, { "name": "Buscar NFS-e en ADN (SEFAZ)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/fetch-from-sefaz", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "fetch-from-sefaz" ] }, "body": { "mode": "raw", "raw": "{\n \"access_key\": \"\",\n \"certificate_id\": \"\",\n \"ambiente\": 1\n}", "options": { "raw": { "language": "json" } } }, "description": "Busca una NFS-e en el Ambiente de Dados Nacional (ADN) usando una clave de acceso de 50 dígitos y un certificado digital previamente registrado (autenticación mTLS)." }, "response": [] }, { "name": "Buscar NFS-e en Barueri", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/fetch-barueri", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "fetch-barueri" ] }, "body": { "mode": "raw", "raw": "{\n \"codigo_autenticidade\": \"\",\n \"cnpj_tomador\": \"\",\n \"ambiente\": \"production\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Busca una NFS-e en el endpoint municipal de Barueri usando el `codigo_autenticidade` impreso en el DANFSE y el CPF/CNPJ del tomador. Devuelve el XML crudo y, cuando se encuentra, la NF-e ya existente en la organización." }, "response": [] }, { "name": "Importar NFS-e Barueri", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/import-barueri", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "import-barueri" ] }, "body": { "mode": "raw", "raw": "{\n \"xml\": \"\",\n \"codigo_autenticidade\": \"\",\n \"cnpj_tomador\": \"\",\n \"ambiente\": \"production\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Importa una NFS-e de Barueri en la base de datos. Acepta un XML crudo (devuelto por `POST /nfes/fetch-barueri`) o el `codigo_autenticidade` + `cnpj_tomador` para re-buscar antes de importar. Crea la `BillingAccount` del tomador cuando aún no existe." }, "response": [] }, { "name": "Obtener NF-e", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar NF-e (borrador)", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"service_description\": \"\",\n \"amount_cents\": 0,\n \"lc116_code\": \"\",\n \"cnae_code\": \"\",\n \"nbs_code\": \"\",\n \"ncm_code\": \"\",\n \"rps_number\": 0,\n \"rps_serial_number\": \"\",\n \"customer_snapshot\": {},\n \"taxes\": {},\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza campos de la NF-e. Solo NF-e en `draft` aceptan cambios en montos y códigos fiscales." }, "response": [] }, { "name": "Eliminar NF-e", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina una NF-e. Permitido solo para estados `draft`, `pending`, `processing`, `error` o `canceled`. NF-e `issued` deben cancelarse vía `POST /nfes/{id}/cancel`." }, "response": [] }, { "name": "Emitir NF-e", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/issue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "issue" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Emite una NF-e en borrador (`draft`) o reintenta una NF-e en `pending`/`error`. Envía la solicitud al proveedor configurado en la organización." }, "response": [] }, { "name": "Cancelar NF-e", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "cancel" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancela una NF-e emitida. Encola la cancelación de forma asíncrona con el proveedor. El `reason` debe tener al menos 15 caracteres y se registra en el audit log." }, "response": [] }, { "name": "Reintentar cancelación de la NF-e", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/retry-cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "retry-cancel" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Reintenta la cancelación de una NF-e atascada en `pending_cancel`, `canceling` o `error`. Re-encola el job de cancelación." }, "response": [] }, { "name": "Sincronizar PDF/XML de la NF-e", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "sync" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Descarga del proveedor el PDF y el XML de la NF-e y los persiste en la base de datos." }, "response": [] }, { "name": "Descargar PDF de la NF-e", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "pdf" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Descarga el PDF de la NF-e (DANFE) como adjunto binario (`application/pdf`). Servido desde la base de datos cuando está disponible; en caso contrario, se busca en el proveedor." }, "response": [] }, { "name": "Descargar XML de la NF-e", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/xml", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "xml" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Descarga el XML de la NF-e como adjunto binario (`application/xml`). Servido desde la base de datos cuando está disponible; en caso contrario, se busca en el proveedor." }, "response": [] }, { "name": "Listar reintentos de solicitud de la NF-e", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/request-tries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "request-tries" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Lista los intentos (`NfeRequestTry`) realizados al proveedor para esta NF-e — una entrada por llamada, con endpoint, estado HTTP, duración y mensajes de error." }, "response": [] }, { "name": "Listar solicitudes externas de la NF-e", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/requests?page=1&per_page=20&sort_by=&sort_order=asc&direction=outbound", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "requests" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "direction", "value": "outbound", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Lista las solicitudes HTTP capturadas para esta NF-e (llamadas al proveedor y webhooks recibidos), con paginación. Usa `direction` para filtrar entre `outbound` e `inbound`." }, "response": [] }, { "name": "Obtener solicitud externa", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/requests/:requestId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "requests", ":requestId" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "requestId", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Validar NFS-e Barueri", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/nfes/:id/validate-barueri", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "validate-barueri" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Re-busca la NFS-e en la municipalidad de Barueri y la compara con el registro local, devolviendo la lista de diferencias y el XML actualizado para reaplicación vía `POST /nfes/import-barueri`." }, "response": [] } ] }, { "name": "Propostas", "item": [ { "name": "Listar propuestas", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals?page=1&per_page=20&sort_by=&sort_order=asc&status=draft&billing_account_id=00000000-0000-0000-0000-000000000000&prospect_id=00000000-0000-0000-0000-000000000000&company_id=00000000-0000-0000-0000-000000000000&template_id=00000000-0000-0000-0000-000000000000&search=&expires_after=&expires_before=&date_from=&date_to=&accepted_from=&accepted_to=&setup_amount_min=0&setup_amount_max=0&monthly_amount_min=0&monthly_amount_max=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "draft", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "prospect_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "template_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "expires_after", "value": "", "disabled": true }, { "key": "expires_before", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true }, { "key": "accepted_from", "value": "", "disabled": true }, { "key": "accepted_to", "value": "", "disabled": true }, { "key": "setup_amount_min", "value": "0", "disabled": true }, { "key": "setup_amount_max", "value": "0", "disabled": true }, { "key": "monthly_amount_min", "value": "0", "disabled": true }, { "key": "monthly_amount_max", "value": "0", "disabled": true } ] }, "description": "Devuelve una lista paginada de las propuestas comerciales de la organización actual." }, "response": [] }, { "name": "Crear propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals" ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"title\": \"\",\n \"description\": \"\",\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"prospect_id\": \"00000000-0000-0000-0000-000000000000\",\n \"contact_id\": \"00000000-0000-0000-0000-000000000000\",\n \"prospect_data\": {\n \"document\": \"\",\n \"name\": \"\",\n \"legal_name\": \"\",\n \"nickname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\"\n },\n \"contact_data\": {\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\"\n },\n \"coupon_id\": \"00000000-0000-0000-0000-000000000000\",\n \"template_id\": \"00000000-0000-0000-0000-000000000000\",\n \"expires_at\": \"\",\n \"notes\": \"\",\n \"items\": [\n {\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 0,\n \"unit_amount_subcents\": 0,\n \"custom_metadata\": {}\n }\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una propuesta comercial. Es obligatorio informar `billing_account_id`, `prospect_id` o `prospect_data` (creación inline del prospect)." }, "response": [] }, { "name": "Obtener estadísticas de propuestas", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/stats", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", "stats" ] }, "description": "Devuelve conteos de propuestas por estado (`draft`, `sent`, `viewed`, `accepted`, `rejected`, `expired`, `canceled`) para la organización actual." }, "response": [] }, { "name": "Cancelar propuestas en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/bulk-cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", "bulk-cancel" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Cancela varias propuestas a la vez (hasta 100). Devuelve conteos de éxito/fallo y errores por id." }, "response": [] }, { "name": "Eliminar propuestas en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/bulk-delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", "bulk-delete" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Elimina varias propuestas a la vez (hasta 100). Devuelve conteos de éxito/fallo y errores por id." }, "response": [] }, { "name": "Enviar propuestas en lote", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/bulk-send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", "bulk-send" ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Envía varias propuestas a la vez (hasta 100). Devuelve conteos de éxito/fallo y errores por id." }, "response": [] }, { "name": "Obtener propuesta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar propuesta", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"title\": \"\",\n \"description\": \"\",\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"prospect_id\": \"00000000-0000-0000-0000-000000000000\",\n \"contact_id\": \"00000000-0000-0000-0000-000000000000\",\n \"prospect_data\": {\n \"document\": \"\",\n \"name\": \"\",\n \"legal_name\": \"\",\n \"nickname\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\"\n },\n \"contact_data\": {\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\"\n },\n \"coupon_id\": \"00000000-0000-0000-0000-000000000000\",\n \"template_id\": \"00000000-0000-0000-0000-000000000000\",\n \"expires_at\": \"\",\n \"notes\": \"\",\n \"items\": [\n {\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 0,\n \"unit_amount_subcents\": 0,\n \"custom_metadata\": {}\n }\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Eliminar propuesta", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Aceptar propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/accept", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "accept" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"cycle\": \"monthly\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Acepta la propuesta y crea (o confirma) la suscripción correspondiente en el ciclo informado." }, "response": [] }, { "name": "Cancelar propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "cancel" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Cancela la propuesta (`status → canceled`)." }, "response": [] }, { "name": "Duplicar propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Crea una nueva propuesta a partir de la original (borrador), preservando ítems y configuración." }, "response": [] }, { "name": "Enviar propuesta por correo", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "send" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"\",\n \"message\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Envía (o reenvía) la propuesta por correo al destinatario. Estados permitidos: `draft`, `sent` o `viewed`. Opcionalmente personaliza `subject` y `message` (HTML)." }, "response": [] }, { "name": "Publicar propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "publish" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Publica la propuesta (`draft → sent`) sin enviar el correo, dejándola disponible en el portal." }, "response": [] }, { "name": "Despublicar propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/unpublish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "unpublish" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Vuelve la propuesta a borrador (`sent`/`viewed` → `draft`)." }, "response": [] }, { "name": "Deshacer aceptación de la propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/undo-accept", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "undo-accept" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Deshace la aceptación: elimina la suscripción vinculada y vuelve el estado a `sent`." }, "response": [] }, { "name": "Generar PDF de la propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/generate-pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "generate-pdf" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Genera (o regenera) el PDF de la propuesta vía Google App Scripts. Requiere un `template` con `app_script_url` configurado." }, "response": [] }, { "name": "Obtener snapshot JSON de la propuesta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/json", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "json" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devuelve el snapshot completo de los datos usados para renderizar el template del PDF (espeja lo que recibe AppScript)." }, "response": [] }, { "name": "Obtener cálculo de precio de la propuesta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/pricing", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "pricing" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Devuelve el detalle de precios por ciclo de cobro (mensual, trimestral, semestral, anual), con setup y descuentos aplicados." }, "response": [] }, { "name": "Listar ítems de la propuesta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "items" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Agregar ítem a la propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "items" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"price_id\": \"00000000-0000-0000-0000-000000000000\",\n \"quantity\": 0,\n \"unit_amount_subcents\": 0,\n \"metadata\": {},\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Obtener ítem de la propuesta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "items", ":itemId" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "itemId", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar ítem de la propuesta", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "items", ":itemId" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "itemId", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"quantity\": 0,\n \"unit_amount_subcents\": 0,\n \"setup_amount_subcents\": 0,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza un ítem. Solo permitido en propuestas en borrador (`status = draft`)." }, "response": [] }, { "name": "Eliminar ítem de la propuesta", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposals/:id/items/:itemId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposals", ":id", "items", ":itemId" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "itemId", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina un ítem. Solo permitido en propuestas en borrador (`status = draft`)." }, "response": [] } ] }, { "name": "Templates de Proposta", "item": [ { "name": "Listar plantillas de propuesta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates?page=1&per_page=20&sort_by=&sort_order=asc&search=&isActive=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "isActive", "value": "false", "disabled": true } ] }, "description": "Devuelve una lista paginada de las plantillas de propuesta de la organización actual." }, "response": [] }, { "name": "Crear plantilla de propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"documentType\": \"google_doc\",\n \"googleDocId\": \"\",\n \"appScriptUrl\": \"https://example.com\",\n \"googleDriveFolderId\": \"\",\n \"isDefault\": false,\n \"isActive\": false,\n \"customMetadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una plantilla de propuesta vinculada a un Google Doc o Google Slides. El `google_doc_id` debe ser único por organización." }, "response": [] }, { "name": "Obtener plantilla de propuesta", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar plantilla de propuesta", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"documentType\": \"google_doc\",\n \"googleDocId\": \"\",\n \"appScriptUrl\": \"https://example.com\",\n \"googleDriveFolderId\": \"\",\n \"isDefault\": false,\n \"isActive\": false,\n \"customMetadata\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Eliminar plantilla de propuesta", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Activar plantilla de propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates", ":id", "activate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Activa una plantilla de propuesta previamente desactivada, dejándola disponible para usar en nuevas propuestas." }, "response": [] }, { "name": "Desactivar plantilla de propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates/:id/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates", ":id", "deactivate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Desactiva una plantilla de propuesta. Las plantillas desactivadas no pueden usarse en nuevas propuestas, pero las propuestas ya creadas permanecen sin cambios." }, "response": [] }, { "name": "Duplicar plantilla de propuesta", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Crea una copia de la plantilla indicada, manteniendo la configuración y los metadatos. La nueva plantilla recibe un nombre derivado y nunca hereda la bandera `is_default`." }, "response": [] }, { "name": "Establecer plantilla como predeterminada", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/proposal_templates/:id/set-default", "host": [ "{{baseUrl}}" ], "path": [ "v1", "proposal_templates", ":id", "set-default" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Marca la plantilla indicada como predeterminada de la organización y quita la bandera de las demás. Solo una plantilla puede ser predeterminada a la vez." }, "response": [] } ] }, { "name": "Mudanças de Plano", "item": [ { "name": "Listar cambios de plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes?page=1&per_page=20&sort_by=&sort_order=asc&subscription_id=00000000-0000-0000-0000-000000000000&change_type=upgrade&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "subscription_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "change_type", "value": "upgrade", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Devuelve el historial paginado de cambios de plan (upgrades, downgrades y laterales) de la organización actual." }, "response": [] }, { "name": "Ejecutar cambio de plan", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes" ] }, "body": { "mode": "raw", "raw": "{\n \"subscription_id\": \"00000000-0000-0000-0000-000000000000\",\n \"to_plan_id\": \"00000000-0000-0000-0000-000000000000\",\n \"timing\": \"immediate\",\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Ejecuta un cambio de plan para una suscripción existente. `timing` controla si el cambio se aplica de inmediato (con prorrateo) o al final del período actual. En caso de éxito, devuelve los UUIDs del `plan_change`, la factura de prorrateo (si existe) y el crédito generado (si existe)." }, "response": [] }, { "name": "Estadísticas de cambios de plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/stats?days=30", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "stats" ], "query": [ { "key": "days", "value": "30", "disabled": true } ] }, "description": "Devuelve agregados de cambios de plan (totales por tipo, por estado, créditos y cargos de prorrateo) para una ventana en días." }, "response": [] }, { "name": "Obtener configuración de cambio de plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/config", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "config" ] }, "description": "Devuelve la configuración por defecto de la organización para upgrades y downgrades — comportamiento de prorrateo, timing y generación de crédito/refund." }, "response": [] }, { "name": "Actualizar configuración de cambio de plan", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/config", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "config" ] }, "body": { "mode": "raw", "raw": "{\n \"allow_upgrade\": false,\n \"allow_downgrade\": false,\n \"upgrade_proration\": \"full_proration\",\n \"downgrade_proration\": \"full_proration\",\n \"upgrade_timing\": \"immediate\",\n \"downgrade_timing\": \"immediate\",\n \"refund_on_downgrade\": false,\n \"credit_on_downgrade\": false,\n \"apply_discount_on_change\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza parcialmente (PATCH) la configuración de cambio de plan de la organización. Todos los campos son opcionales." }, "response": [] }, { "name": "Listar reglas de cambio de plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/rules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "rules" ] }, "description": "Lista las reglas personalizadas que sobrescriben el comportamiento por defecto para transiciones específicas entre planes." }, "response": [] }, { "name": "Crear regla de cambio de plan", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/rules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "rules" ] }, "body": { "mode": "raw", "raw": "{\n \"from_plan_id\": \"00000000-0000-0000-0000-000000000000\",\n \"to_plan_id\": \"00000000-0000-0000-0000-000000000000\",\n \"change_type\": \"upgrade\",\n \"allowed\": false,\n \"timing\": \"immediate\",\n \"proration_method\": \"full_proration\",\n \"discount_percent\": 0,\n \"bonus_days\": 0,\n \"message\": \"\",\n \"priority\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una nueva regla para una transición entre planes. Permite bloquear/permitir la transición, definir timing, prorrateo, descuentos y días bonus." }, "response": [] }, { "name": "Obtener regla de cambio de plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "rules", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar regla de cambio de plan", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "rules", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"allowed\": false,\n \"timing\": \"immediate\",\n \"proration_method\": \"full_proration\",\n \"discount_percent\": 0,\n \"bonus_days\": 0,\n \"message\": \"\",\n \"priority\": 0,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Eliminar regla de cambio de plan", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", "rules", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Obtener cambio de plan", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/plan_changes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "plan_changes", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] } ] }, { "name": "Mudanças de Assinatura", "item": [ { "name": "Obtener configuración de cambios de suscripción", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscription_changes/config", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_changes", "config" ] }, "description": "Devuelve la configuración de la organización para cambios en ítems de suscripción — operaciones permitidas (agregar/eliminar/cambiar cantidad/cambiar precio), método de prorrateo por operación, momento de aplicación (`immediate` o `end_of_period`), reembolso/crédito al eliminar y self-service en el portal. Si aún no existe, se crea con los valores por defecto en la primera lectura." }, "response": [] }, { "name": "Actualizar configuración de cambios de suscripción", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscription_changes/config", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_changes", "config" ] }, "body": { "mode": "raw", "raw": "{\n \"allow_item_add\": false,\n \"allow_item_remove\": false,\n \"allow_quantity_change\": false,\n \"allow_price_swap\": false,\n \"add_proration\": \"full_proration\",\n \"remove_proration\": \"full_proration\",\n \"quantity_up_proration\": \"full_proration\",\n \"quantity_down_proration\": \"full_proration\",\n \"add_timing\": \"immediate\",\n \"remove_timing\": \"immediate\",\n \"quantity_up_timing\": \"immediate\",\n \"quantity_down_timing\": \"immediate\",\n \"refund_on_remove\": false,\n \"credit_on_remove\": false,\n \"portal_self_service\": false,\n \"portal_require_confirmation\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza parcialmente la configuración. Solo se modifican los campos enviados. `refund_on_remove` requiere que `credit_on_remove` también esté habilitado — el reembolso es una variante del crédito." }, "response": [] }, { "name": "Listar cambios de ítems de suscripción", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscription_item_changes?page=1&per_page=20&sort_by=&sort_order=asc&subscription_id=00000000-0000-0000-0000-000000000000&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_item_changes" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "subscription_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Devuelve una lista paginada de los cambios aplicados (o agendados) sobre ítems de suscripciones de la organización — agregados, eliminaciones, cambios de cantidad y cambios de precio. Cada registro incluye el snapshot de las operaciones, los montos de prorrateo en **subcents** (÷10000 → BRL) y los punteros a la factura/credit generados." }, "response": [] }, { "name": "Obtener cambio de ítem de suscripción", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/subscription_item_changes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscription_item_changes", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] } ] }, { "name": "Uso (Metered)", "item": [ { "name": "Listar registros de uso", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage?subscription_item_id=00000000-0000-0000-0000-000000000000&product_slug=&customer_id=&start_date=&end_date=&limit=0&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage" ], "query": [ { "key": "subscription_item_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "product_slug", "value": "", "disabled": true }, { "key": "customer_id", "value": "", "disabled": true }, { "key": "start_date", "value": "", "disabled": true }, { "key": "end_date", "value": "", "disabled": true }, { "key": "limit", "value": "0", "disabled": true }, { "key": "offset", "value": "0", "disabled": true } ] }, "description": "Devuelve los registros de uso (metered) de un ítem de suscripción. Identifica el ítem por `subscription_item_id` **o** por la combinación `product_slug` + `customer_id`. Admite filtros por rango de fechas y ventana `limit`/`offset`." }, "response": [] }, { "name": "Reportar uso (metered)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage" ] }, "body": { "mode": "raw", "raw": "{\n \"subscription_item_id\": \"00000000-0000-0000-0000-000000000000\",\n \"product_slug\": \"\",\n \"customer_id\": \"\",\n \"quantity\": 5,\n \"action\": \"increment\",\n \"timestamp\": \"2026-01-01T00:00:00Z\",\n \"idempotency_key\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Reporta uso para facturación metered. Acepta un registro único **o** un lote `{ records: [...] }` con hasta **100** ítems. Cada registro debe identificar el ítem de suscripción por `subscription_item_id` **o** por `product_slug` + `customer_id` (recomendado para integraciones externas). El precio/producto debe estar configurado con `usage_type=metered` y la suscripción debe estar `active` o `trialing`. Usa `idempotency_key` para evitar duplicados — cuando la clave ya fue vista, la respuesta marca `duplicate: true`. Los lotes con fallas parciales devuelven **207 Multi-Status**." }, "response": [] }, { "name": "Resumen de uso del período", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage/summary?subscription_item_id=00000000-0000-0000-0000-000000000000&product_slug=&customer_id=&period_start=&period_end=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage", "summary" ], "query": [ { "key": "subscription_item_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "product_slug", "value": "", "disabled": true }, { "key": "customer_id", "value": "", "disabled": true }, { "key": "period_start", "value": "", "disabled": true }, { "key": "period_end", "value": "", "disabled": true } ] }, "description": "Devuelve la agregación de uso de un ítem de suscripción en el período de cobro vigente (o en un período arbitrario vía `period_start`/`period_end`). Considera registros `set` (que reemplazan) y la suma de los `increment` posteriores. Cuando el precio es por tiers o unitario, calcula un costo estimado en `estimated_cost_cents` (÷100 → BRL)." }, "response": [] }, { "name": "Listar snapshots diarios de uso", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage/snapshots/daily?billing_account_id=00000000-0000-0000-0000-000000000000&product_id=00000000-0000-0000-0000-000000000000&start_date=&end_date=&limit=0&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage", "snapshots", "daily" ], "query": [ { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "product_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "start_date", "value": "", "disabled": true }, { "key": "end_date", "value": "", "disabled": true }, { "key": "limit", "value": "0", "disabled": true }, { "key": "offset", "value": "0", "disabled": true } ] }, "description": "Lista los snapshots diarios de uso de la organización. Filtros opcionales: `billing_account_id`, `product_id` y ventana `start_date`/`end_date`. Admite paginación por `limit`/`offset`." }, "response": [] }, { "name": "Crear snapshots diarios de uso", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage/snapshots/daily", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage", "snapshots", "daily" ] }, "body": { "mode": "raw", "raw": "{\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"billing_account_public_id\": \"\",\n \"product_group_slug\": \"\",\n \"product_slug\": \"\",\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"snapshot_date\": \"2026-03-15\",\n \"quantity\": 0,\n \"idempotency_key\": \"\",\n \"calculated_at\": \"2026-01-01T00:00:00Z\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea snapshots diarios de uso, registro único **o** lote `{ records: [...] }` con hasta **100** ítems. La clave natural (organización, cuenta de cobro, producto, fecha) es única: si ya existe, el snapshot es sobrescrito (`overwritten: true`). Resuelve la cuenta por `billing_account_id` **o** `billing_account_public_id` y el producto por `product_slug` **o** `product_id` dentro del `product_group_slug` informado. Los lotes con fallas parciales devuelven **207 Multi-Status**." }, "response": [] }, { "name": "Listar snapshots mensuales de uso", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage/snapshots/monthly?billing_account_id=00000000-0000-0000-0000-000000000000&product_id=00000000-0000-0000-0000-000000000000&start_month=&end_month=&limit=0&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage", "snapshots", "monthly" ], "query": [ { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "product_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "start_month", "value": "", "disabled": true }, { "key": "end_month", "value": "", "disabled": true }, { "key": "limit", "value": "0", "disabled": true }, { "key": "offset", "value": "0", "disabled": true } ] }, "description": "Lista los snapshots mensuales de uso de la organización. Filtros opcionales: `billing_account_id`, `product_id` y ventana `start_month`/`end_month`. Admite paginación por `limit`/`offset`." }, "response": [] }, { "name": "Crear snapshots mensuales de uso", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage/snapshots/monthly", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage", "snapshots", "monthly" ] }, "body": { "mode": "raw", "raw": "{\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"billing_account_public_id\": \"\",\n \"product_group_slug\": \"\",\n \"product_slug\": \"\",\n \"product_id\": \"00000000-0000-0000-0000-000000000000\",\n \"month\": \"2026-03-01\",\n \"total_quantity\": 0,\n \"avg_daily_quantity\": 0,\n \"days_with_usage\": 0,\n \"plan_limit\": 0,\n \"excess_quantity\": 0,\n \"idempotency_key\": \"\",\n \"calculated_at\": \"2026-01-01T00:00:00Z\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea snapshots mensuales de uso, registro único **o** lote `{ records: [...] }` con hasta **100** ítems. La clave natural (organización, cuenta de cobro, producto, mes) es única: si ya existe, el snapshot es sobrescrito (`overwritten: true`). Resuelve la cuenta por `billing_account_id` **o** `billing_account_public_id` y el producto por `product_slug` **o** `product_id` dentro de `product_group_slug`. Los lotes con fallas parciales devuelven **207 Multi-Status**." }, "response": [] } ] }, { "name": "Regras Tributárias", "item": [ { "name": "Listar reglas tributarias", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_rules?page=1&per_page=20&sort_by=&sort_order=asc&scope=global&company_id=00000000-0000-0000-0000-000000000000&service_item_id=00000000-0000-0000-0000-000000000000&billing_account_id=00000000-0000-0000-0000-000000000000&is_active=true&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_rules" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "scope", "value": "global", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "service_item_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "billing_account_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "is_active", "value": "true", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de las reglas tributarias de la organización actual. Usa los filtros `scope`, `company_id`, `service_item_id`, `billing_account_id` e `is_active` para acotar el resultado." }, "response": [] }, { "name": "Crear regla tributaria", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_rules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_rules" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"scope\": \"global\",\n \"priority\": 0,\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"service_item_id\": \"00000000-0000-0000-0000-000000000000\",\n \"billing_account_id\": \"00000000-0000-0000-0000-000000000000\",\n \"customer_tax_type\": \"pessoa_fisica\",\n \"municipality\": \"\",\n \"operation_type\": \"interno\",\n \"effective_from\": \"2026-01-01T00:00:00Z\",\n \"effective_to\": \"2026-01-01T00:00:00Z\",\n \"items\": [\n {\n \"tax_type\": \"iss\",\n \"rate\": 5,\n \"is_withheld\": false,\n \"base_type\": \"service_value\",\n \"is_exempt\": false,\n \"exemption_reason\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea una nueva regla tributaria con sus ítems (alícuotas por tributo). El `scope` define el nivel de aplicación y la `priority` define la precedencia — las reglas de mayor prioridad sobrescriben a las menores. Es obligatorio informar al menos un ítem en `items`." }, "response": [] }, { "name": "Obtener regla tributaria", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_rules", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar regla tributaria", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_rules", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"priority\": 0,\n \"is_active\": false,\n \"effective_to\": \"2026-01-01T00:00:00Z\",\n \"items\": [\n {\n \"tax_type\": \"iss\",\n \"rate\": 5,\n \"is_withheld\": false,\n \"base_type\": \"service_value\",\n \"is_exempt\": false,\n \"exemption_reason\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza los campos editables de la regla. Cuando se informa `items`, **reemplaza** por completo la lista de ítems existente." }, "response": [] }, { "name": "Eliminar regla tributaria", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_rules", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] } ] }, { "name": "Períodos Tributários", "item": [ { "name": "Listar períodos tributarios", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_periods?page=1&per_page=20&sort_by=&sort_order=asc&company_id=00000000-0000-0000-0000-000000000000&period_type=monthly&year=&status=open", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_periods" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "period_type", "value": "monthly", "disabled": true }, { "key": "year", "value": "", "disabled": true }, { "key": "status", "value": "open", "disabled": true } ] }, "description": "Devuelve una lista paginada de los períodos tributarios (mensuales o trimestrales) de la organización. Permite filtrar por empresa, tipo de período, año y estado." }, "response": [] }, { "name": "Procesar período tributario mensual", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_periods", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_periods" ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"year\": 2026,\n \"month\": 6\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea (o recupera) el período tributario mensual indicado y calcula los impuestos debidos (ISS, PIS, COFINS, IRPJ, CSLL, CBS, IBS) con base en las NFes emitidas y las retenciones a compensar. Cuando se omite `company_id`, usa la empresa por defecto de la organización." }, "response": [] }, { "name": "Obtener período tributario", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_periods/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_periods", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Ejecutar acción en el período tributario", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_periods/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_periods", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"action\": \"recalculate\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Aplica una acción sobre el período: `recalculate` recalcula los impuestos (solo períodos mensuales), `close` cierra el período y `reopen` lo reabre." }, "response": [] }, { "name": "Eliminar período tributario", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/tax_periods/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax_periods", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina permanentemente el período tributario. Use con precaución — los períodos cerrados normalmente no deben eliminarse." }, "response": [] } ] }, { "name": "Retenções", "item": [ { "name": "Listar retenciones", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/withholdings?page=1&per_page=20&sort_by=&sort_order=asc&taxType=iss&status=retained&withholderId=00000000-0000-0000-0000-000000000000&invoiceId=00000000-0000-0000-0000-000000000000&nfeId=00000000-0000-0000-0000-000000000000&competenceYear=0&competenceMonth=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", "withholdings" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "taxType", "value": "iss", "disabled": true }, { "key": "status", "value": "retained", "disabled": true }, { "key": "withholderId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "invoiceId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "nfeId", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "competenceYear", "value": "0", "disabled": true }, { "key": "competenceMonth", "value": "0", "disabled": true } ] }, "description": "Devuelve una lista paginada de las retenciones tributarias de la organización actual. Admite filtros por tipo de tributo, estado, retenedor, factura, NF-e y competencia." }, "response": [] }, { "name": "Convertir retenciones pendientes en créditos (en lote)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/withholdings/convert-to-credits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "withholdings", "convert-to-credits" ] }, "body": { "mode": "raw", "raw": "{\n \"tax_type\": \"iss\",\n \"competence_year\": 0,\n \"competence_month\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Convierte todas las retenciones pendientes de la organización — opcionalmente acotadas por `tax_type` y/o competencia — en créditos. Devuelve la lista de créditos generados, la cantidad total convertida y el monto total en centavos." }, "response": [] }, { "name": "Obtener retención", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/withholdings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "withholdings", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Convertir retención en crédito", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/withholdings/:id/convert-to-credit", "host": [ "{{baseUrl}}" ], "path": [ "v1", "withholdings", ":id", "convert-to-credit" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount_cents\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Convierte una retención (total o parcialmente) en un crédito en la cuenta de cobro derivada de la factura asociada — o, en su ausencia, del propio retenedor. Cuando se omite `amount_cents`, convierte el saldo pendiente de la retención." }, "response": [] } ] }, { "name": "Itens de Serviço (LC 116)", "item": [ { "name": "Listar ítems de servicio", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/service_items?page=1&per_page=20&sort_by=&sort_order=asc&company_id=00000000-0000-0000-0000-000000000000&search=&is_active=true&lc116_code=&nbs_code=&c_class_trib=&indop_code=&simples_annex=annex_iii", "host": [ "{{baseUrl}}" ], "path": [ "v1", "service_items" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "company_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_active", "value": "true", "disabled": true }, { "key": "lc116_code", "value": "", "disabled": true }, { "key": "nbs_code", "value": "", "disabled": true }, { "key": "c_class_trib", "value": "", "disabled": true }, { "key": "indop_code", "value": "", "disabled": true }, { "key": "simples_annex", "value": "annex_iii", "disabled": true } ] }, "description": "Devuelve una lista paginada de los ítems de servicio (catálogo LC 116/2003) de la organización actual. Usa los filtros para restringir por empresa, código LC 116, NBS, clasificación tributaria, indicador de operación o anexo del Simples." }, "response": [] }, { "name": "Crear ítem de servicio", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/service_items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "service_items" ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"description\": \"\",\n \"internal_code\": \"\",\n \"lc116_code\": \"01.05\",\n \"municipal_code\": \"\",\n \"nbs_code\": \"\",\n \"cnae_code\": \"\",\n \"simples_annex\": \"annex_iii\",\n \"default_iss_rate\": 2.5,\n \"subject_to_irrf\": false,\n \"subject_to_csrf\": false,\n \"subject_to_inss\": false,\n \"subject_to_iss_withholding\": false,\n \"c_class_trib\": \"\",\n \"cbs_ibs_category\": \"\",\n \"indop_code\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea un ítem de servicio en el catálogo LC 116/2003. `internal_code` es el identificador interno y `lc116_code` debe seguir el catálogo de la Ley Complementaria 116/2003 (p. ej. `01.05`). Cuando se informa `company_id`, la empresa debe pertenecer a la organización autenticada." }, "response": [] }, { "name": "Obtener ítem de servicio", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/service_items/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "service_items", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar ítem de servicio", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/service_items/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "service_items", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"description\": \"\",\n \"lc116_code\": \"\",\n \"municipal_code\": \"\",\n \"nbs_code\": \"\",\n \"cnae_code\": \"\",\n \"simples_annex\": \"annex_iii\",\n \"default_iss_rate\": 0,\n \"subject_to_irrf\": false,\n \"subject_to_csrf\": false,\n \"subject_to_inss\": false,\n \"subject_to_iss_withholding\": false,\n \"c_class_trib\": \"\",\n \"cbs_ibs_category\": \"\",\n \"indop_code\": \"\",\n \"is_active\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza campos editables del ítem de servicio. `internal_code` es inmutable después de la creación. Usa `is_active=false` para desactivar el ítem sin eliminarlo." }, "response": [] }, { "name": "Eliminar ítem de servicio", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/service_items/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "service_items", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina el ítem de servicio permanentemente. Para preservar el historial en facturas o NFS-e ya emitidas, prefiere desactivar el ítem (`PATCH` con `is_active=false`)." }, "response": [] } ] }, { "name": "Administração da Conta", "item": [ { "name": "Listar usuarios del dashboard", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users?page=1&per_page=20&sort_by=&sort_order=asc&search=&status=all&role=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "status", "value": "all", "disabled": true }, { "key": "role", "value": "", "disabled": true } ] }, "description": "Devuelve una lista paginada de los usuarios del dashboard (miembros del equipo) de la organización actual." }, "response": [] }, { "name": "Invitar usuario del dashboard", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"name\": \"\",\n \"external_id\": \"\",\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"permissions\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Invita a un nuevo miembro al equipo de la organización. Es obligatorio informar `email` y al menos un rol en `role_ids`. El usuario recibe una invitación por correo y entra con estado `pending_invitation`." }, "response": [] }, { "name": "Obtener usuario del dashboard", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar usuario del dashboard", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"picture\": \"\",\n \"status\": \"active\",\n \"permissions\": [\n \"\"\n ],\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza el nombre, la foto, el estado, los permisos y/o los roles del usuario. Solo se modifican los campos enviados." }, "response": [] }, { "name": "Eliminar usuario del dashboard", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Elimina al usuario del dashboard de la organización. Acción irreversible — el usuario debe ser invitado de nuevo para recuperar el acceso." }, "response": [] }, { "name": "Listar roles del equipo", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles?page=1&per_page=20&sort_by=&sort_order=asc&search=&is_active=false&is_system=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_active", "value": "false", "disabled": true }, { "key": "is_system", "value": "false", "disabled": true } ] }, "description": "Devuelve la lista paginada de roles configurados para el equipo de la organización. Incluye tanto roles de sistema (`is_system = true`) como roles personalizados." }, "response": [] }, { "name": "Crear rol personalizado", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"billing_manager\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Crea un rol personalizado. El `slug` debe empezar con una letra minúscula y contener solo letras minúsculas, dígitos y `_`." }, "response": [] }, { "name": "Obtener rol", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Actualizar rol", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Actualiza los campos del rol. Solo se modifican los campos enviados. Los roles de sistema tienen restricciones adicionales." }, "response": [] }, { "name": "Eliminar rol", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Realiza soft delete del rol. Los roles de sistema (`is_system = true`) no pueden eliminarse." }, "response": [] } ] } ] }