{ "info": { "name": "API do Faturamento Automático (v1.0.0)", "description": "Hey dev, have fun! ✨\n\n> **Documentation index** — fetch the full index at [https://docs.billing.kobana.com.br/llms.txt](https://docs.billing.kobana.com.br/llms.txt). Use this file to discover every available page before exploring further.\n\n> **Mind the API versions** — you are reading the **v1.0** documentation of the Automatic Billing API, which covers the **Subscriptions** endpoints (create, plan change, pause, cancel, manual invoicing, item sync) and related resources. Resources like **Payments, Transfers, Statements and Pix Receivables** live in other Kobana APIs — use the product picker in the top menu to switch.\n\n## Format\n\nThe API only accepts `JSON`. Every request must use `Content-Type: application/json`. All responses use `snake_case`.\n\n| Field type | Format |\n| :--- | :--- |\n| **DateTime** | [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format. Examples — Date: `2026-01-24`. Date and time: `2026-01-24T10:07Z` |\n| **Money (`_cents`)** | Integer in cents (÷100). E.g.: `10000` = R$ 100.00 |\n| **Money (`_subcents`)** | Integer in sub-cents (÷10000), used for pricing. E.g.: `1000000` = R$ 100.00 |\n| **UUID** | Resource identifiers as UUID v4 |\n\n## Conventions\n\nConventions used in this documentation:\n\n| Convention | Description |\n| :--- | :--- |\n| **`:variable`** | A variable name that must be replaced in the URL. |\n| **`#{variable}`** | A variable name that must be replaced with values from your account. |\n| **`...`** | Response content truncated for readability. |\n| **`$KOBANA_TOKEN`** | Access token. For command-line testing, export it: `export KOBANA_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxx` then paste the docs commands into your terminal. |\n\n## Return Codes\n\nThe API returns standard HTTP status codes:\n\n| | Code | Description |\n| :--- | :--- | :--- |\n| ✅ | **200 OK** | Successful request with a response body. |\n| ✅ | **201 Created** | Resource created successfully. |\n| ✅ | **204 No Content** | Successful request without a response body. |\n| ❌ | **400 Bad Request** | Invalid request, usually malformed content. |\n| ❌ | **401 Unauthorized** | Missing or invalid access token. |\n| ❌ | **403 Forbidden** | API access blocked or user not authorized. |\n| ❌ | **404 Not Found** | Resource not found. |\n| ❌ | **422 Unprocessable Entity** | Valid request, but the data is not. |\n| ❌ | **429 Too Many Requests** | Rate limit reached. |\n| ❌ | **500 Internal Server Error** | Internal processing error. Check [server status](https://status.kobana.com.br). |\n\n## Request ID\n\nEvery request has an associated identifier in the `Request-Id` response header. This value helps with debugging and auditing — requests and their IDs are available in the system dashboard. Request logs are retained for **30 days**. When opening a support ticket about a specific request, provide the `Request-Id` to speed up the investigation.\n\n## Security\n\nThe Kobana API uses **2048-bit SSL** certificates. Every request must use **HTTPS** — calls on port 80 are redirected to 443.\n\nClients must support `TLSv1.2` or `TLSv1.3` with one of the ciphers: `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` and `TLSv1.1` are not supported.\n\n## HTTP Caching\n\nUse HTTP cache headers to reduce load and improve speed. Most responses include `ETag` and/or `Last-Modified` — store these values and send them back on follow-up requests via `If-None-Match` and `If-Modified-Since`. If the resource hasn't changed you'll get `304 Not Modified` — no body, no reprocessing. More info: [HTTP Cache Docs](http://www.mnot.net/cache_docs/).\n\n## Error Handling\n\n5xx errors mean a server failure: **500 Internal Server Error** (application unavailable), **502 Bad Gateway**, **503 Service Unavailable** and **504 Gateway Timeout** (point-in-time infrastructure failures). Your application must catch these and retry the request after a few minutes with backoff. Server status: [https://status.kobana.com.br](https://status.kobana.com.br).\n\n## Monetary values\n\nMonetary values follow two conventions: fields with the `_cents` suffix (÷100) and pricing fields with the `_subcents` suffix (÷10000). Use these conventions to convert to BRL before displaying to the end user.", "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 — Production. Overridden at runtime when `API_V1_PUBLIC_URL` is set.\nhttps://api.billing.sandbox.kobana.com.br — Sandbox — isolated testing environment, separate from production." }, { "key": "bearerToken", "value": "", "type": "string", "description": "JWT (HS512) usado no header Authorization: Bearer." } ], "item": [ { "name": "Assinaturas", "item": [ { "name": "List subscriptions", "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": "Returns a paginated list of the current organization's subscriptions." }, "response": [] }, { "name": "Create subscription", "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": "Creates a subscription. Either `plan_id` or `items` is required." }, "response": [] }, { "name": "Get subscription", "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": "Update subscription", "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": "Cancel and remove subscription (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": "Pause subscription", "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": "Suspends charging while keeping the subscription open. `behavior` controls how invoices generated during the pause are handled." }, "response": [] }, { "name": "Resume paused subscription", "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": "Cancel subscription", "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": "Cancels immediately, or schedules for end of period when `cancel_at_period_end=true`." }, "response": [] }, { "name": "Activate draft/confirmed subscription", "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": "Change subscription 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/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 or downgrade. Proration follows the subscription's `proration_behavior`." }, "response": [] }, { "name": "Revert subscription to confirmed state", "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": "Generate an ad-hoc invoice for the subscription", "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": "List subscription items", "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": "Resync items with the current 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/subscriptions/:id/sync-plan-items", "host": [ "{{baseUrl}}" ], "path": [ "v1", "subscriptions", ":id", "sync-plan-items" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Realigns subscription items with the plan-items template (manual reconciliation)." }, "response": [] } ] }, { "name": "Contas de Cobrança", "item": [ { "name": "List billing accounts", "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": "Returns a paginated list of the current organization's billing accounts." }, "response": [] }, { "name": "Create billing account", "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": "Creates a billing account associated with a customer. The `customer` block locates an existing customer by `id`, `external_id` or `document_number`; when not found, creates a new one (requires `name` and `document_number`)." }, "response": [] }, { "name": "Get billing account", "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": "Update billing account", "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": "Close billing account", "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": "Closes the billing account (equivalent to `POST /billing_accounts/{id}/close`)." }, "response": [] }, { "name": "Close billing account (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": "Closes the billing account. The `reason` is recorded in the audit log." }, "response": [] }, { "name": "Suspend billing account", "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": "Suspends the account. The `reason` is recorded in the audit log." }, "response": [] }, { "name": "Reactivate billing account", "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": "Reactivates a suspended billing account." }, "response": [] }, { "name": "List billing account invoices", "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": "Returns a paginated list of the billing account's invoices." }, "response": [] }, { "name": "List billing account subscriptions", "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": "Returns a paginated list of the billing account's subscriptions." }, "response": [] }, { "name": "List billing account credits", "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": "Returns a paginated list of the billing account's credits." }, "response": [] } ] }, { "name": "Clientes", "item": [ { "name": "List customers", "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": "Returns a paginated list of the current organization's customers." }, "response": [] }, { "name": "Create customer", "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": "Creates a customer and, by default, an associated billing account. Use `create_billing_account=false` to create only the customer." }, "response": [] }, { "name": "Get customer", "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": "The `{id}` parameter accepts the customer UUID or its `external_id`." }, "response": [] }, { "name": "Update customer", "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": "The `{id}` parameter accepts the customer UUID or its `external_id`." }, "response": [] }, { "name": "Remove customer (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": "Marks the customer as removed without deleting historical records." }, "response": [] }, { "name": "List customer financial statement", "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": "Returns statement entries (invoices, payments, credit applications) for the customer's billing account. When the customer has multiple accounts, provide `billing_account_id`." }, "response": [] }, { "name": "Rebuild the statement from history", "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": "Recreates statement items from existing invoices, payments and credit applications. Returns a summary of what was created." }, "response": [] }, { "name": "Recalculate customer MRR", "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": "Recalculates the MRR (Monthly Recurring Revenue) of the customer's billing accounts from active subscriptions." }, "response": [] }, { "name": "List customer portal users", "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": "Returns portal users linked to the customer's billing account." }, "response": [] }, { "name": "Invite portal user", "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": "Creates a portal access invitation for the given email. The invitation expires in 7 days." }, "response": [] }, { "name": "Invite portal user (verb)", "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": "Equivalent to `POST /customers/{id}/users`. Available as a verb route for SDKs that prefer descriptive URLs." }, "response": [] }, { "name": "Get portal user", "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": "The `{user_id}` parameter accepts the user's UUID or `external_id`." }, "response": [] }, { "name": "Update portal user", "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": "Updates `email`, `external_id`, `sso_only` and `status`. Allowed status transitions: `active` ↔ `suspended`." }, "response": [] }, { "name": "Remove portal user", "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": "Pending invitations are permanently removed; active users are suspended." }, "response": [] }, { "name": "Preview portal user email", "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": "Returns the subject and body of the invitation or verification email that would be sent to the user, without actually sending it. Available only for `pending_invitation` or `pending_verification` users." }, "response": [] }, { "name": "Resend invitation or verification email", "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": "Resends the invitation email (for `pending_invitation`, rotating the token) or verification email (for `pending_verification`). Other statuses return 400." }, "response": [] } ] }, { "name": "Planos", "item": [ { "name": "List plans", "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": "Returns a paginated list of the current organization's plans." }, "response": [] }, { "name": "Create 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": "Creates a plan for the authenticated organization." }, "response": [] }, { "name": "Get 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": "Update 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": "Archive or delete 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": "By default archives the plan (soft delete). Use `?hard=true` to permanently delete a draft plan." }, "response": [] }, { "name": "Duplicate 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": "Creates a copy of the plan (including its items) in draft state." }, "response": [] }, { "name": "List plan items", "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": "Replace plan items", "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": "Atomically replaces all plan items. Only root products are accepted and each `product_id` must be unique in the list." }, "response": [] }, { "name": "Bulk archive plans", "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": "Bulk delete plans", "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": "Permanently deletes the given plans. Plans with active subscriptions are skipped and returned in `skipped_ids`." }, "response": [] }, { "name": "Bulk move plans to another group", "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": "List plan groups", "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": "Returns all of the current organization's plan groups ordered by `display_order`." }, "response": [] }, { "name": "Create plan group", "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": "Get plan group", "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": "Update plan group", "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": "Remove plan group", "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": "Reorder plan groups", "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": "Updates each group `display_order` according to the order of the `group_ids` array. All groups must belong to the current organization." }, "response": [] }, { "name": "Archive plan group", "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": "Marks the group as archived by setting `archived_at`. Archived groups are hidden from default listings." }, "response": [] } ] }, { "name": "Produtos", "item": [ { "name": "List products", "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": "Returns a paginated list of the current organization's products." }, "response": [] }, { "name": "Create product", "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": "Get product", "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": "Update product", "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": "Archive product (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": "Archives the product. Returns 422 when the product is in use by active subscriptions." }, "response": [] }, { "name": "Archive product", "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": "Archives the product. Returns 422 when the product is in use by active subscriptions or is already archived." }, "response": [] }, { "name": "Publish product", "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": "Promotes a draft product to active status." }, "response": [] }, { "name": "Restore archived product", "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": "Restores an archived product back to active status." }, "response": [] }, { "name": "Reorder products", "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": "Updates product display order. Array index 0 becomes the first item in the list." }, "response": [] }, { "name": "Reorder products (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` for `/products/reorder`. Same behavior as the `POST` version." }, "response": [] }, { "name": "Bulk archive products", "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": "Archives multiple products. IDs in use by active subscriptions or already archived are skipped and reported in the response." }, "response": [] }, { "name": "Bulk delete products", "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": "Permanently deletes multiple products. IDs in use by active subscriptions are skipped and reported in the response." }, "response": [] }, { "name": "Bulk change visibility", "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": "Updates the visibility (`public` or `private`) of multiple products." }, "response": [] }, { "name": "Move products to another group", "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": "Moves multiple products to a product group. Send `product_group_id: null` to remove from the current group." }, "response": [] }, { "name": "Bulk change product company", "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": "Reassigns multiple products to another company. Send `company_id: null` to clear the link." }, "response": [] } ] }, { "name": "Grupos de Produto", "item": [ { "name": "List product groups", "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": "Returns a paginated list of the current organization's product groups." }, "response": [] }, { "name": "Create product group", "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": "Get product group", "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": "Update product group", "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": "Remove product group", "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": "Archive product group", "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": "Unarchive product group", "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": "Reorder product groups", "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": "Updates the display order of product groups. The `group_ids` array defines the new order — index 0 becomes the first group." }, "response": [] }, { "name": "Reorder product groups (PUT alias)", "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` for `POST /product_groups/reorder`. Same contract." }, "response": [] } ] }, { "name": "Organização", "item": [ { "name": "Get current organization", "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": "Returns the data of the organization the authenticated token belongs to. There is no `:id` parameter — the organization is always resolved from the API key." }, "response": [] }, { "name": "Update current organization", "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": "Updates the profile of the authenticated organization. Only the fields below can be modified — identity (`id`, `external_id`, `status`) is not changeable through this endpoint." }, "response": [] } ] }, { "name": "Empresas", "item": [ { "name": "List companies", "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": "Returns a paginated list of the current organization's companies (head offices and branches)." }, "response": [] }, { "name": "Create company", "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": "Creates a company (head office or branch). To create a branch, provide `parent_company_id` — the CNPJ must share the same prefix as the head office. Only CNPJ companies can have branches. The first company created in the organization is flagged as `is_default` automatically." }, "response": [] }, { "name": "List head office companies", "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": "Lists the active head office companies (without `parent_company_id`) of the organization. Useful when selecting the parent company before creating a branch. Only CNPJ companies appear here." }, "response": [] }, { "name": "Get company", "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": "Update company", "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": "Deactivate company", "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": "Deactivates the company (soft delete — equivalent to `POST /companies/{id}/deactivate`). Cannot deactivate the only active company, nor a company that has active or trialing subscriptions." }, "response": [] }, { "name": "Set default company", "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": "Marks the company as the organization's default. The previous default is unset in the same transaction." }, "response": [] }, { "name": "Deactivate company (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": "Deactivates the company. Cannot deactivate the only active company, nor a company that has active or trialing subscriptions. If the deactivated company was the default, another active company is promoted automatically." }, "response": [] }, { "name": "Reactivate company", "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": "Reactivates a previously deactivated company. Returns **422** when the company is already active." }, "response": [] }, { "name": "Get fiscal profile", "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": "Returns the company's fiscal profile, or `null` when it has not been configured yet." }, "response": [] }, { "name": "Update fiscal profile", "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": "Creates or updates (upsert) the company fiscal profile. Includes taxation regime, rates (ISS, PIS, COFINS, CSLL, IRPJ) and CBS/IBS settings." }, "response": [] }, { "name": "Get fiscal profile (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 of `GET /companies/{id}/fiscal` — same representation and behaviour." }, "response": [] }, { "name": "Update fiscal profile (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 of `PATCH /companies/{id}/fiscal` — same representation and behaviour." }, "response": [] } ] }, { "name": "Certificados", "item": [ { "name": "List digital certificates", "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": "Returns a paginated list of the current organization’s digital (A1) certificates. For security reasons, the response **never** includes the private key nor the PFX password — only metadata extracted from the certificate." }, "response": [] }, { "name": "Upload digital certificate", "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": "Uploads an A1 digital certificate via `multipart/form-data`. The private key and password are encrypted at rest and are **never** returned by the API. The endpoint detects duplicates by `thumbprint` and automatically associates the certificate with a `person` based on the extracted CNPJ/CPF.\n\nAccepted `type` values:\n- `pfx` — send `file` (binary PFX/P12) and `password`.\n- `cert_key` — send `cert_file` (certificate PEM) and `key_file` (key PEM).\n- `combined_pem` — send `file` (PEM containing certificate + key).\n- `cert_key_password` — send `cert_file`, `key_file` and `password` (password-protected key)." }, "response": [] }, { "name": "Get certificate", "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": "Delete certificate", "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": "Removes the certificate via **soft delete**. Encrypted data remains in the database for audit purposes only." }, "response": [] } ] }, { "name": "Cupons", "item": [ { "name": "List coupons", "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": "Returns a paginated list of the current organization's coupons." }, "response": [] }, { "name": "Create coupon", "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": "Creates a discount coupon. The `code` must be unique per organization. Use `discount_type=percentage` with `discount_value` between `0` and `100`, or `discount_type=fixed_amount` with `discount_value` in cents (÷100 → BRL)." }, "response": [] }, { "name": "Get coupon", "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": "Update coupon", "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": "Updates editable coupon fields. `code`, `discount_type`, `discount_value` and `currency` are immutable after creation." }, "response": [] }, { "name": "Delete coupon", "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": "Deletes the coupon permanently. Allowed only while the coupon **has no recorded redemptions** — otherwise use `POST /coupons/{id}/deactivate` to preserve history." }, "response": [] }, { "name": "Deactivate coupon", "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": "Deactivates the coupon: new redemptions are blocked, but previous redemptions are preserved." }, "response": [] }, { "name": "List coupon redemptions", "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": "Returns a paginated list of the coupon's recorded redemptions." }, "response": [] } ] }, { "name": "Créditos", "item": [ { "name": "List credits", "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": "Returns a paginated list of credits in the current organization. By default, expired credits are omitted — use `usage` or `include_expired` to include them." }, "response": [] }, { "name": "Add credit", "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": "Adds a credit to a billing account. The amount is credited to the `BillingAccount` `balance_cents` and becomes available to settle future invoices. When `company_id` is provided, the credit can only be applied to invoices from the same `company`." }, "response": [] }, { "name": "Get credit", "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": "Update credit", "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": "Adjusts the credit (type, amount, description or expiration). `amount_cents` can only change if the credit has not been partially used — otherwise the API responds with `400`." }, "response": [] }, { "name": "Delete credit", "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": "Removes the credit and reverses the matching balance on the billing account. Only allowed if no cents of the credit have been consumed — otherwise the API responds with `400`." }, "response": [] } ] }, { "name": "Faturas", "item": [ { "name": "List invoices", "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": "Returns a paginated list of the current organization's invoices." }, "response": [] }, { "name": "Create invoice", "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": "Creates an invoice for a billing account. Accepts line items, optional installments (`installments`, minimum 2) and NF-e issuance policy." }, "response": [] }, { "name": "List invoices with pending payment", "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": "Returns finalized invoices (`status = open`) past their `due_date`." }, "response": [] }, { "name": "List invoices with pending 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/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": "Returns paid invoices that still need NF-e emission — no NF-e, or NF-e in `pending`, `processing` or `error` status." }, "response": [] }, { "name": "Get invoice", "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": "Update invoice", "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": "Delete invoice", "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": "Deletes a draft (`draft`) invoice. Finalized invoices must be canceled via `POST /invoices/{id}/void`." }, "response": [] }, { "name": "Finalize invoice", "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": "Finalizes a draft invoice (`draft` → `open`)." }, "response": [] }, { "name": "Void invoice", "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": "Voids an open invoice (`open` → `void`). The `reason` is recorded in the audit log." }, "response": [] }, { "name": "Undo invoice payment", "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": "Reverts the invoice payment (`paid` → `open`). The `reason` is recorded in the audit log." }, "response": [] }, { "name": "Pay invoice", "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": "Two modes: (a) when `payment_method` is provided, creates a gateway payment (`pix`, `bank_slip` or `card`) and returns the method artifacts (QR code, barcode or card status); (b) when omitted, marks the invoice as paid manually (reconciliation)." }, "response": [] }, { "name": "Send invoice reminder", "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": "Sends an invoice payment reminder email to the billing account's `billing_email`." }, "response": [] }, { "name": "Issue NF-e for invoice", "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": "Triggers issuance of the NF-e (Electronic Invoice) for the invoice." }, "response": [] }, { "name": "Apply credits to invoice", "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": "Applies billing-account credits to an open (`status = open`) invoice." }, "response": [] }, { "name": "Remove applied credits", "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": "Removes all credits applied to the invoice, returning them to the billing account. Only works on open (`status = open`) invoices." }, "response": [] }, { "name": "Download invoice PDF", "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": "Generates and downloads the invoice PDF as a binary attachment (`application/pdf`)." }, "response": [] }, { "name": "List available payment methods", "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": "Lists the payment methods available to pay this invoice, based on the organization's active gateways and portal settings." }, "response": [] }, { "name": "List invoice installments", "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": "Create/update installment schedule", "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": "Creates or replaces the invoice installment schedule. Minimum of 2 installments." }, "response": [] }, { "name": "Mark installment as paid", "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": "Manually marks an installment as paid (reconciliation, no gateway call)." }, "response": [] }, { "name": "Pay installment", "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": "Processes payment for a specific installment via the gateway. The previous installment must be paid." }, "response": [] } ] }, { "name": "Pagamentos", "item": [ { "name": "List payments", "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": "Returns a paginated list of the current organization's payments." }, "response": [] }, { "name": "Process payment", "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": "Processes a payment for an existing invoice. Accepts a previously registered `payment_method_id` **or** a `payment_method` block with card/PIX/bank-slip data. When `amount_cents` is omitted, charges the invoice open balance." }, "response": [] }, { "name": "Reassign payments to another invoice", "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": "Bulk-updates the invoice associated with the given payments. Useful for fixing links when payments arrived pointing to the wrong invoice." }, "response": [] }, { "name": "Get payment", "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": "Delete payment", "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": "Removes a payment. Confirmed payments cannot be deleted — use `cancel` or `refund` instead." }, "response": [] }, { "name": "Cancel payment", "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": "Cancels an open payment. When `cancel_on_gateway` is `true` (default), the cancellation is propagated to the gateway." }, "response": [] }, { "name": "Retry payment", "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": "Reprocesses a failed payment. Optionally switches to a new card (via `card`) or to a saved payment method (`payment_method_id`)." }, "response": [] }, { "name": "Change payment card", "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": "Replaces the credit card on a failed Pagar.me payment. The new card must be pre-registered in `payment_methods`." }, "response": [] }, { "name": "Change bank slip due date", "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": "Changes the due date of a pending bank-slip payment issued via the Kobana gateway. The new date must be in the future." }, "response": [] }, { "name": "Send bank slip by email", "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": "Sends the bank-slip link by email to the given recipient. Only available for pending bank-slip payments." }, "response": [] }, { "name": "Sync payment with 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": "Syncs the payment status with the upstream gateway (Kobana PIX/boleto or Pagar.me refund). Returns the refreshed payment." }, "response": [] }, { "name": "Refund payment", "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": "Refunds a successful payment. Without `amount_cents`, refunds the full amount; with a partial amount, issues a partial refund." }, "response": [] } ] }, { "name": "Métodos de Pagamento", "item": [ { "name": "List payment methods", "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": "Returns a paginated list of the current organization's payment methods. Optional filters: `billing_account_id`, `type`, `status`." }, "response": [] }, { "name": "Create payment method", "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": "Creates a payment method tied to a billing account. For `type=card`, send the `card` block with the `cardToken` produced by client-side tokenization. For `type=bank_transfer`, send the `bankAccount` block. For `bank_slip` and `pix`, only the `type` is required — the default gateway is resolved from the organization." }, "response": [] }, { "name": "Get payment method", "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": "Update card expiration", "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": "Updates only the expiration month and year of the card tied to the method. Fails when `type` is not `card`." }, "response": [] }, { "name": "Delete payment method", "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-deletes the payment method (marks it as `removed`). Fails when there are pending or processing payments. If it was the default, another active method is automatically promoted." }, "response": [] }, { "name": "Set payment method as default", "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": "Marks the method as the billing account's default and unsets previous defaults. Fails when the method is not `active`." }, "response": [] } ] }, { "name": "NF-e", "item": [ { "name": "List 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": "Returns a paginated list of the current organization's NF-e (electronic invoices)." }, "response": [] }, { "name": "Create draft 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", "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": "Creates a draft (`draft`) NF-e for later issuance via `POST /nfes/{id}/issue`. Accepts taker data (`customer`) and optional tax rates." }, "response": [] }, { "name": "Sync organization 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/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", "sync" ] }, "description": "Triggers a background job to sync every organization NF-e with the provider (updates status, downloads pending PDFs/XMLs). Returns the `job_id` for polling. Refuses if a sync is already running." }, "response": [] }, { "name": "Bulk update 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/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": "Updates multiple NF-e at once. Currently supports linking or unlinking an invoice (`invoice_id`) on up to 100 NF-e per request." }, "response": [] }, { "name": "Bulk delete 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/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": "Deletes up to 100 NF-e at once. All must be in `draft` status and belong to the current organization." }, "response": [] }, { "name": "List request retries (organization)", "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": "Lists every NF-e provider request attempt for the organization, paginated and ordered by descending date." }, "response": [] }, { "name": "Fetch NFS-e from 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": "Fetches an NFS-e from the Ambiente de Dados Nacional (ADN) using a 50-digit access key and a previously registered digital certificate (mTLS authentication)." }, "response": [] }, { "name": "Fetch NFS-e from 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": "Fetches an NFS-e from the Barueri municipal endpoint using the `codigo_autenticidade` printed on the DANFSE and the taker's CPF/CNPJ. Returns the raw XML and, when found, the NF-e already present in the organization." }, "response": [] }, { "name": "Import Barueri NFS-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/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": "Imports a Barueri NFS-e into the database. Accepts a raw XML (returned by `POST /nfes/fetch-barueri`) or the `codigo_autenticidade` + `cnpj_tomador` to re-fetch before importing. Creates the taker `BillingAccount` when it does not yet exist." }, "response": [] }, { "name": "Get 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": "Update draft NF-e", "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": "Updates NF-e fields. Only `draft` NF-e accept changes to amounts and fiscal codes." }, "response": [] }, { "name": "Delete 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": "Deletes an NF-e. Allowed only for `draft`, `pending`, `processing`, `error` or `canceled` statuses. `issued` NF-e must be canceled via `POST /nfes/{id}/cancel`." }, "response": [] }, { "name": "Issue 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": "Issues a draft (`draft`) NF-e or retries one in `pending`/`error`. Sends the request to the provider configured for the organization." }, "response": [] }, { "name": "Cancel 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": "Cancels an issued NF-e. Enqueues the cancellation asynchronously with the provider. The `reason` must be at least 15 characters and is recorded in the audit log." }, "response": [] }, { "name": "Retry NF-e cancellation", "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": "Retries cancellation of an NF-e stuck in `pending_cancel`, `canceling` or `error`. Re-enqueues the cancellation job." }, "response": [] }, { "name": "Sync NF-e PDF/XML", "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": "Downloads the NF-e PDF and XML from the provider and stores them in the database." }, "response": [] }, { "name": "Download NF-e PDF", "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": "Downloads the NF-e PDF (DANFE) as a binary attachment (`application/pdf`). Served from the database when available; otherwise fetched from the provider." }, "response": [] }, { "name": "Download NF-e XML", "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": "Downloads the NF-e XML as a binary attachment (`application/xml`). Served from the database when available; otherwise fetched from the provider." }, "response": [] }, { "name": "List NF-e request retries", "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": "Lists the attempts (`NfeRequestTry`) made to the provider for this NF-e — one entry per call, with endpoint, HTTP status, duration and error messages." }, "response": [] }, { "name": "List NF-e external requests", "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": "Lists captured HTTP requests for this NF-e (provider calls and incoming webhooks), paginated. Use `direction` to filter between `outbound` and `inbound`." }, "response": [] }, { "name": "Get external request", "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": "Validate Barueri NFS-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/validate-barueri", "host": [ "{{baseUrl}}" ], "path": [ "v1", "nfes", ":id", "validate-barueri" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Re-fetches the NFS-e from the Barueri municipality and compares it to the local record, returning the diff list and the fresh XML for reapplication via `POST /nfes/import-barueri`." }, "response": [] } ] }, { "name": "Propostas", "item": [ { "name": "List proposals", "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": "Returns a paginated list of the current organization's commercial proposals." }, "response": [] }, { "name": "Create proposal", "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": "Creates a commercial proposal. You must provide `billing_account_id`, `prospect_id` or `prospect_data` (inline prospect creation)." }, "response": [] }, { "name": "Get proposal statistics", "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": "Returns proposal counts by status (`draft`, `sent`, `viewed`, `accepted`, `rejected`, `expired`, `canceled`) for the current organization." }, "response": [] }, { "name": "Bulk cancel proposals", "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": "Cancels multiple proposals at once (up to 100). Returns success/failure counts and errors per id." }, "response": [] }, { "name": "Bulk delete proposals", "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": "Deletes multiple proposals at once (up to 100). Returns success/failure counts and errors per id." }, "response": [] }, { "name": "Bulk send proposals", "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": "Sends multiple proposals at once (up to 100). Returns success/failure counts and errors per id." }, "response": [] }, { "name": "Get proposal", "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": "Update proposal", "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": "Delete proposal", "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": "Accept proposal", "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": "Accepts the proposal and creates (or confirms) the corresponding subscription using the given cycle." }, "response": [] }, { "name": "Cancel proposal", "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": "Cancels the proposal (`status → canceled`)." }, "response": [] }, { "name": "Duplicate proposal", "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": "Creates a new proposal from the original (as draft), preserving items and configuration." }, "response": [] }, { "name": "Send proposal email", "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": "Sends (or resends) the proposal email to the recipient. Allowed statuses: `draft`, `sent` or `viewed`. Optionally customize `subject` and `message` (HTML)." }, "response": [] }, { "name": "Publish proposal", "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": "Publishes the proposal (`draft → sent`) without sending the email, making it available on the portal." }, "response": [] }, { "name": "Unpublish proposal", "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": "Reverts the proposal to draft (`sent`/`viewed` → `draft`)." }, "response": [] }, { "name": "Undo proposal acceptance", "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": "Reverts the acceptance: removes the linked subscription and returns status to `sent`." }, "response": [] }, { "name": "Generate proposal PDF", "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": "Generates (or regenerates) the proposal PDF via Google App Scripts. Requires a `template` with `app_script_url` configured." }, "response": [] }, { "name": "Get proposal JSON snapshot", "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": "Returns the full data snapshot used to render the PDF template (mirrors what AppScript receives)." }, "response": [] }, { "name": "Get proposal pricing breakdown", "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": "Returns the pricing breakdown per billing cycle (monthly, quarterly, semiannual, annual), with setup and discounts applied." }, "response": [] }, { "name": "List proposal items", "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": "Add item to proposal", "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": "Get proposal item", "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": "Update proposal item", "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": "Updates an item. Only allowed on draft (`status = draft`) proposals." }, "response": [] }, { "name": "Delete proposal item", "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": "Removes an item. Only allowed on draft (`status = draft`) proposals." }, "response": [] } ] }, { "name": "Templates de Proposta", "item": [ { "name": "List proposal templates", "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": "Returns a paginated list of the current organization's proposal templates." }, "response": [] }, { "name": "Create proposal template", "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": "Creates a proposal template linked to a Google Doc or Google Slides. The `google_doc_id` must be unique per organization." }, "response": [] }, { "name": "Get proposal template", "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": "Update proposal template", "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": "Delete proposal template", "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": "Activate proposal template", "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": "Activates a previously deactivated proposal template, making it available for use in new proposals." }, "response": [] }, { "name": "Deactivate proposal template", "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": "Deactivates a proposal template. Deactivated templates cannot be used in new proposals, but proposals already created remain unchanged." }, "response": [] }, { "name": "Duplicate proposal template", "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": "Creates a copy of the given template, keeping configuration and metadata. The new template gets a derived name and never inherits the `is_default` flag." }, "response": [] }, { "name": "Set template as default", "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": "Marks the given template as the organization default and removes the flag from the others. Only one template can be default at a time." }, "response": [] } ] }, { "name": "Mudanças de Plano", "item": [ { "name": "List plan changes", "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": "Returns the paginated history of plan changes (upgrades, downgrades and lateral) for the current organization." }, "response": [] }, { "name": "Execute plan change", "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": "Executes a plan change for an existing subscription. `timing` controls whether the change applies immediately (with proration) or at the end of the current period. On success, returns the UUIDs of the `plan_change`, the proration invoice (if any) and the generated credit (if any)." }, "response": [] }, { "name": "Plan change stats", "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": "Returns plan change aggregates (totals by type, by status, proration credits and charges) for a window in days." }, "response": [] }, { "name": "Get plan change config", "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": "Returns the organization's default configuration for upgrades and downgrades — proration behavior, timing and credit/refund generation." }, "response": [] }, { "name": "Update plan change config", "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": "Partially updates (PATCH) the organization's plan change configuration. All fields are optional." }, "response": [] }, { "name": "List plan change rules", "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": "Lists custom rules that override the default behavior for specific plan-to-plan transitions." }, "response": [] }, { "name": "Create plan change rule", "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": "Creates a new rule for a plan-to-plan transition. Lets you block/allow the transition, set timing, proration, discounts and bonus days." }, "response": [] }, { "name": "Get plan change rule", "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": "Update plan change rule", "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": "Delete plan change rule", "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": "Get plan change", "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": "Get subscription change settings", "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": "Returns the organization settings for subscription item changes — allowed operations (add/remove/quantity change/price swap), proration method per operation, timing (`immediate` or `end_of_period`), refund/credit on remove and portal self-service. If not yet present, defaults are created on first read." }, "response": [] }, { "name": "Update subscription change settings", "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": "Partially updates the settings. Only supplied fields are changed. `refund_on_remove` requires `credit_on_remove` to also be enabled — refund is a variant of credit." }, "response": [] }, { "name": "List subscription item changes", "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": "Returns a paginated list of changes applied (or scheduled) to the organization's subscription items — additions, removals, quantity changes and price swaps. Each record includes the operations snapshot, proration amounts in **subcents** (÷10000 → BRL) and pointers to the resulting invoice/credit." }, "response": [] }, { "name": "Get subscription item change", "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": "List usage records", "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": "Returns metered usage records for a subscription item. Identify the item by `subscription_item_id` **or** by the `product_slug` + `customer_id` combination. Supports date-range filtering and `limit`/`offset` windowing." }, "response": [] }, { "name": "Report usage (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": "Reports usage for metered billing. Accepts a single record **or** a `{ records: [...] }` batch of up to **100** items. Each record must identify the subscription item by `subscription_item_id` **or** by `product_slug` + `customer_id` (recommended for external integrations). The price/product must be configured with `usage_type=metered` and the subscription must be `active` or `trialing`. Use `idempotency_key` to avoid duplicates — when a key was already seen the response is flagged with `duplicate: true`. Batches with partial failures return **207 Multi-Status**." }, "response": [] }, { "name": "Usage summary for the period", "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": "Returns the aggregated usage of a subscription item for the current billing period (or for an arbitrary period via `period_start`/`period_end`). Honors `set` records (which replace) and the sum of subsequent `increment` records. When the price is tiered or per-unit, computes an estimated cost in `estimated_cost_cents` (÷100 → BRL)." }, "response": [] }, { "name": "List daily usage snapshots", "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": "Lists the organization's daily usage snapshots. Optional filters: `billing_account_id`, `product_id` and `start_date`/`end_date` window. Supports `limit`/`offset` pagination." }, "response": [] }, { "name": "Create daily usage snapshots", "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": "Creates daily usage snapshots, single record **or** `{ records: [...] }` batch up to **100** items. The natural key (organization, billing account, product, date) is unique: when present, the snapshot is overwritten (`overwritten: true`). Resolve the account by `billing_account_id` **or** `billing_account_public_id` and the product by `product_slug` **or** `product_id` within the supplied `product_group_slug`. Batches with partial failures return **207 Multi-Status**." }, "response": [] }, { "name": "List monthly usage snapshots", "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": "Lists the organization's monthly usage snapshots. Optional filters: `billing_account_id`, `product_id` and `start_month`/`end_month` window. Supports `limit`/`offset` pagination." }, "response": [] }, { "name": "Create monthly usage snapshots", "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": "Creates monthly usage snapshots, single record **or** `{ records: [...] }` batch up to **100** items. The natural key (organization, billing account, product, month) is unique: when present, the snapshot is overwritten (`overwritten: true`). Resolve the account by `billing_account_id` **or** `billing_account_public_id` and the product by `product_slug` **or** `product_id` within `product_group_slug`. Batches with partial failures return **207 Multi-Status**." }, "response": [] } ] }, { "name": "Regras Tributárias", "item": [ { "name": "List tax rules", "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": "Returns a paginated list of the current organization's tax rules. Use the `scope`, `company_id`, `service_item_id`, `billing_account_id` and `is_active` filters to narrow the result." }, "response": [] }, { "name": "Create tax rule", "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": "Creates a new tax rule along with its items (per-tax rates). The `scope` defines the applicability level and `priority` defines precedence — higher priority overrides lower. At least one entry in `items` is required." }, "response": [] }, { "name": "Get tax rule", "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": "Update tax rule", "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": "Updates editable fields of the rule. When `items` is provided, it **fully replaces** the existing items list." }, "response": [] }, { "name": "Delete tax rule", "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": "List tax periods", "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": "Returns a paginated list of the organization tax periods (monthly or quarterly). Supports filtering by company, period type, year and status." }, "response": [] }, { "name": "Process monthly tax period", "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": "Creates (or retrieves) the given monthly tax period and computes the taxes due (ISS, PIS, COFINS, IRPJ, CSLL, CBS, IBS) based on issued NFes and pending compensation. When `company_id` is omitted, uses the organization default company." }, "response": [] }, { "name": "Get tax period", "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": "Run action on tax period", "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": "Applies an action to the period: `recalculate` recomputes taxes (monthly periods only), `close` closes the period and `reopen` reopens it." }, "response": [] }, { "name": "Delete tax period", "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": "Permanently removes the tax period. Use with caution — closed periods usually should not be deleted." }, "response": [] } ] }, { "name": "Retenções", "item": [ { "name": "List withholdings", "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": "Returns a paginated list of the current organization's tax withholdings. Supports filters by tax type, status, withholder, invoice, NF-e and competence period." }, "response": [] }, { "name": "Convert pending withholdings to credits (bulk)", "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": "Converts all of the organization's pending withholdings — optionally narrowed by `tax_type` and/or competence period — into credits. Returns the list of generated credits, the total count converted and the total amount in cents." }, "response": [] }, { "name": "Get withholding", "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": "Convert withholding to credit", "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": "Converts a withholding (fully or partially) into a credit on the billing account derived from the associated invoice — or, when absent, from the withholder itself. When `amount_cents` is omitted, converts the withholding's pending balance." }, "response": [] } ] }, { "name": "Itens de Serviço (LC 116)", "item": [ { "name": "List service items", "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": "Returns a paginated list of the current organization's service items (LC 116/2003 catalog). Use the filters to narrow by company, LC 116 code, NBS, tax classification, operation indicator, or Simples annex." }, "response": [] }, { "name": "Create service item", "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": "Creates a service item in the LC 116/2003 catalog. `internal_code` is the internal identifier and `lc116_code` must follow the Complementary Law 116/2003 catalog (e.g. `01.05`). When `company_id` is provided, the company must belong to the authenticated organization." }, "response": [] }, { "name": "Get service item", "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": "Update service item", "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": "Updates editable fields of the service item. `internal_code` is immutable after creation. Use `is_active=false` to deactivate the item without deleting it." }, "response": [] }, { "name": "Delete service item", "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": "Deletes the service item permanently. To preserve history on already-issued invoices or NFS-e, prefer deactivating the item (`PATCH` with `is_active=false`)." }, "response": [] } ] }, { "name": "Administração da Conta", "item": [ { "name": "List dashboard users", "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": "Returns a paginated list of dashboard users (team members) for the current organization." }, "response": [] }, { "name": "Invite dashboard user", "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": "Invites a new member to the organization team. `email` and at least one role in `role_ids` are required. The user receives an email invite and starts with `pending_invitation` status." }, "response": [] }, { "name": "Get dashboard user", "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": "Update dashboard user", "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": "Updates the user’s name, picture, status, permissions and/or roles. Only the fields sent are changed." }, "response": [] }, { "name": "Remove dashboard user", "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": "Removes the dashboard user from the organization. Irreversible — the user must be invited again to regain access." }, "response": [] }, { "name": "List team roles", "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": "Returns the paginated list of roles configured for the organization team. Includes both system roles (`is_system = true`) and custom roles." }, "response": [] }, { "name": "Create custom role", "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": "Creates a custom role. `slug` must start with a lowercase letter and contain only lowercase letters, digits and `_`." }, "response": [] }, { "name": "Get role", "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": "Update role", "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": "Updates the role fields. Only the fields sent are changed. System roles have additional restrictions." }, "response": [] }, { "name": "Remove role", "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": "Soft-deletes the role. System roles (`is_system = true`) cannot be removed." }, "response": [] } ] } ] }