{ "openapi": "3.1.0", "info": { "title": "DuckLedger API", "version": "1.0.0", "summary": "DuckLedger financial infrastructure and complete platform API.", "description": "The canonical DuckLedger API reference, including the public Asaas parity surface, authenticated control-plane operations, authentication endpoints, inbound webhooks and health checks.", "contact": { "name": "DuckLedger", "url": "https://www.duckledger.com/developers" } }, "servers": [ { "url": "https://api.duckledger.com", "description": "Production" }, { "url": "https://sandbox-api.duckledger.com", "description": "Sandbox" }, { "url": "http://localhost:3333", "description": "Local development" } ], "tags": [ { "name": "Ações em sandbox", "description": "DuckLedger operations in the Ações em sandbox capability family." }, { "name": "Antecipações", "description": "DuckLedger operations in the Antecipações capability family." }, { "name": "Assinaturas", "description": "DuckLedger operations in the Assinaturas capability family." }, { "name": "Cartão de crédito", "description": "DuckLedger operations in the Cartão de crédito capability family." }, { "name": "Chargeback", "description": "DuckLedger operations in the Chargeback capability family." }, { "name": "Checkout", "description": "DuckLedger operations in the Checkout capability family." }, { "name": "Clientes", "description": "DuckLedger operations in the Clientes capability family." }, { "name": "Cobranças", "description": "DuckLedger operations in the Cobranças capability family." }, { "name": "Cobranças com dados resumidos", "description": "DuckLedger operations in the Cobranças com dados resumidos capability family." }, { "name": "Configurações de Webhooks", "description": "DuckLedger operations in the Configurações de Webhooks capability family." }, { "name": "Consulta Serasa", "description": "DuckLedger operations in the Consulta Serasa capability family." }, { "name": "Conta Escrow", "description": "DuckLedger operations in the Conta Escrow capability family." }, { "name": "Documentos de cobranças", "description": "DuckLedger operations in the Documentos de cobranças capability family." }, { "name": "Envio de documentos White Label", "description": "DuckLedger operations in the Envio de documentos White Label capability family." }, { "name": "Estornos", "description": "DuckLedger operations in the Estornos capability family." }, { "name": "Extrato", "description": "DuckLedger operations in the Extrato capability family." }, { "name": "Informações e personalização da conta", "description": "DuckLedger operations in the Informações e personalização da conta capability family." }, { "name": "Informações financeiras", "description": "DuckLedger operations in the Informações financeiras capability family." }, { "name": "Informações fiscais", "description": "DuckLedger operations in the Informações fiscais capability family." }, { "name": "Link de pagamentos", "description": "DuckLedger operations in the Link de pagamentos capability family." }, { "name": "Negativações", "description": "DuckLedger operations in the Negativações capability family." }, { "name": "Notas fiscais", "description": "DuckLedger operations in the Notas fiscais capability family." }, { "name": "Notificações", "description": "DuckLedger operations in the Notificações capability family." }, { "name": "Pagamento de contas", "description": "DuckLedger operations in the Pagamento de contas capability family." }, { "name": "Parcelamentos", "description": "DuckLedger operations in the Parcelamentos capability family." }, { "name": "Pix", "description": "DuckLedger operations in the Pix capability family." }, { "name": "Pix Automático", "description": "DuckLedger operations in the Pix Automático capability family." }, { "name": "Pix Recorrente", "description": "DuckLedger operations in the Pix Recorrente capability family." }, { "name": "Recargas de celular", "description": "DuckLedger operations in the Recargas de celular capability family." }, { "name": "Registro de Recebíveis", "description": "DuckLedger operations in the Registro de Recebíveis capability family." }, { "name": "Splits", "description": "DuckLedger operations in the Splits capability family." }, { "name": "Subcontas Asaas", "description": "DuckLedger operations in the Subcontas Asaas capability family." }, { "name": "Transações Pix", "description": "DuckLedger operations in the Transações Pix capability family." }, { "name": "Transferências", "description": "DuckLedger operations in the Transferências capability family." }, { "name": "ai-costs", "description": "DuckLedger operations in the ai-costs capability family." }, { "name": "api-keys", "description": "DuckLedger operations in the api-keys capability family." }, { "name": "audit", "description": "DuckLedger operations in the audit capability family." }, { "name": "auth", "description": "DuckLedger operations in the auth capability family." }, { "name": "aws-connections", "description": "DuckLedger operations in the aws-connections capability family." }, { "name": "checkout-sessions", "description": "DuckLedger operations in the checkout-sessions capability family." }, { "name": "connected-accounts", "description": "DuckLedger operations in the connected-accounts capability family." }, { "name": "conversions", "description": "DuckLedger operations in the conversions capability family." }, { "name": "cost-categories", "description": "DuckLedger operations in the cost-categories capability family." }, { "name": "customer-metrics", "description": "DuckLedger operations in the customer-metrics capability family." }, { "name": "customers", "description": "DuckLedger operations in the customers capability family." }, { "name": "customer-attributes", "description": "DuckLedger operations in the customer-attributes capability family." }, { "name": "dashboard", "description": "DuckLedger operations in the dashboard capability family." }, { "name": "data-sources", "description": "DuckLedger operations in the data-sources capability family." }, { "name": "data-io", "description": "DuckLedger operations in the data-io capability family." }, { "name": "duck-ai", "description": "DuckLedger operations in the duck-ai capability family." }, { "name": "entitlements", "description": "DuckLedger operations in the entitlements capability family." }, { "name": "exchange-rates", "description": "DuckLedger operations in the exchange-rates capability family." }, { "name": "expenses", "description": "DuckLedger operations in the expenses capability family." }, { "name": "formulas", "description": "DuckLedger operations in the formulas capability family." }, { "name": "gateway-accounts", "description": "DuckLedger operations in the gateway-accounts capability family." }, { "name": "gateway-api-logs", "description": "DuckLedger operations in the gateway-api-logs capability family." }, { "name": "margin", "description": "DuckLedger operations in the margin capability family." }, { "name": "metrics", "description": "DuckLedger operations in the metrics capability family." }, { "name": "mrr-movements", "description": "DuckLedger operations in the mrr-movements capability family." }, { "name": "notifications", "description": "DuckLedger operations in the notifications capability family." }, { "name": "organizations", "description": "DuckLedger operations in the organizations capability family." }, { "name": "payment-methods", "description": "DuckLedger operations in the payment-methods capability family." }, { "name": "payments", "description": "DuckLedger operations in the payments capability family." }, { "name": "plans", "description": "DuckLedger operations in the plans capability family." }, { "name": "platform-admin", "description": "DuckLedger operations in the platform-admin capability family." }, { "name": "platform-billing", "description": "DuckLedger operations in the platform-billing capability family." }, { "name": "profitability", "description": "DuckLedger operations in the profitability capability family." }, { "name": "projection", "description": "DuckLedger operations in the projection capability family." }, { "name": "public-cancellation-survey", "description": "DuckLedger operations in the public-cancellation-survey capability family." }, { "name": "shared-dashboard", "description": "DuckLedger operations in the shared-dashboard capability family." }, { "name": "public-recovery", "description": "DuckLedger operations in the public-recovery capability family." }, { "name": "retention", "description": "DuckLedger operations in the retention capability family." }, { "name": "revenue-attribution", "description": "DuckLedger operations in the revenue-attribution capability family." }, { "name": "revenue-metrics", "description": "DuckLedger operations in the revenue-metrics capability family." }, { "name": "revenue", "description": "DuckLedger operations in the revenue capability family." }, { "name": "segments", "description": "DuckLedger operations in the segments capability family." }, { "name": "sql-queries", "description": "DuckLedger operations in the sql-queries capability family." }, { "name": "store-access", "description": "DuckLedger operations in the store-access capability family." }, { "name": "store-analytics", "description": "DuckLedger operations in the store-analytics capability family." }, { "name": "store-connections", "description": "DuckLedger operations in the store-connections capability family." }, { "name": "store-webhooks", "description": "DuckLedger operations in the store-webhooks capability family." }, { "name": "subscriptions", "description": "DuckLedger operations in the subscriptions capability family." }, { "name": "suppliers", "description": "DuckLedger operations in the suppliers capability family." }, { "name": "usage", "description": "DuckLedger operations in the usage capability family." }, { "name": "webhook-endpoints", "description": "DuckLedger operations in the webhook-endpoints capability family." }, { "name": "webhook-logs", "description": "DuckLedger operations in the webhook-logs capability family." }, { "name": "webhooks", "description": "DuckLedger operations in the webhooks capability family." }, { "name": "whatsapp-connections", "description": "DuckLedger operations in the whatsapp-connections capability family." }, { "name": "workspaces", "description": "DuckLedger operations in the workspaces capability family." }, { "name": "health", "description": "DuckLedger operations in the health capability family." } ], "paths": { "/api/v1/sandbox/myAccount/approve": { "post": { "tags": [ "Ações em sandbox" ], "summary": "(Apenas Sandbox) Aprovar conta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/sandbox/myAccount/approve` capability.", "operationId": "aprovar-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/sandbox/myAccount/approve", "url": "https://docs.asaas.com/reference/aprovar-conta", "operation": "(Apenas Sandbox) Aprovar conta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/sandbox/payment/{id}/confirm": { "post": { "tags": [ "Ações em sandbox" ], "summary": "(Apenas sandbox) Confirmar o pagamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/sandbox/payment/{id}/confirm` capability.", "operationId": "confirmar-pagamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/sandbox/payment/{id}/confirm", "url": "https://docs.asaas.com/reference/confirmar-pagamento", "operation": "(Apenas sandbox) Confirmar o pagamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/sandbox/payment/{id}/overdue": { "post": { "tags": [ "Ações em sandbox" ], "summary": "(Apenas sandbox) Forçar o vencimento de uma cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/sandbox/payment/{id}/overdue` capability.", "operationId": "forcar-vencimento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/sandbox/payment/{id}/overdue", "url": "https://docs.asaas.com/reference/forcar-vencimento", "operation": "(Apenas sandbox) Forçar o vencimento de uma cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations": { "get": { "tags": [ "Antecipações" ], "summary": "Listar antecipações", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/anticipations` capability.", "operationId": "listar-antecipacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations", "url": "https://docs.asaas.com/reference/listar-antecipacoes", "operation": "Listar antecipações" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Antecipações" ], "summary": "Solicitar antecipação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/anticipations` capability.", "operationId": "solicitar-antecipacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/anticipations", "url": "https://docs.asaas.com/reference/solicitar-antecipacao", "operation": "Solicitar antecipação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations/{id}": { "get": { "tags": [ "Antecipações" ], "summary": "Recuperar uma única antecipação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/anticipations/{id}` capability.", "operationId": "recuperar-uma-unica-antecipacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-antecipacao", "operation": "Recuperar uma única antecipação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/anticipations/{id}/cancel": { "post": { "tags": [ "Antecipações" ], "summary": "Cancelar antecipação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/anticipations/{id}/cancel` capability.", "operationId": "cancelar-antecipacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/anticipations/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-antecipacao", "operation": "Cancelar antecipação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations/configurations": { "get": { "tags": [ "Antecipações" ], "summary": "Recuperar status da antecipação automática", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/anticipations/configurations` capability.", "operationId": "recuperar-status-da-antecipacao-automatica", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations/configurations", "url": "https://docs.asaas.com/reference/recuperar-status-da-antecipacao-automatica", "operation": "Recuperar status da antecipação automática" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Antecipações" ], "summary": "Atualizar status da antecipação automática", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/anticipations/configurations` capability.", "operationId": "atualizar-status-da-antecipacao-automatica", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/anticipations/configurations", "url": "https://docs.asaas.com/reference/atualizar-status-da-antecipacao-automatica", "operation": "Atualizar status da antecipação automática" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations/limits": { "get": { "tags": [ "Antecipações" ], "summary": "Recuperar limites de antecipações", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/anticipations/limits` capability.", "operationId": "recuperar-limites-de-antecipacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations/limits", "url": "https://docs.asaas.com/reference/recuperar-limites-de-antecipacoes", "operation": "Recuperar limites de antecipações" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/anticipations/simulate": { "post": { "tags": [ "Antecipações" ], "summary": "Simular antecipação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/anticipations/simulate` capability.", "operationId": "simular-antecipação", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/anticipations/simulate", "url": "https://docs.asaas.com/reference/simular-antecipação", "operation": "Simular antecipação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions": { "get": { "tags": [ "Assinaturas", "subscriptions" ], "summary": "Listar assinaturas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions` capability.\n\nThis route is implemented by `SubscriptionsController.list`.", "operationId": "listar-assinaturas", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "SubscriptionsController.list", "x-duckledger-source": "apps/api/src/modules/subscriptions/subscriptions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ], "x-duckledger-permission": "subscriptions.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions", "url": "https://docs.asaas.com/reference/listar-assinaturas", "operation": "Listar assinaturas" } ] }, "post": { "tags": [ "Assinaturas", "subscriptions" ], "summary": "Criar nova assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/subscriptions` capability.\n\nAlso covers the Asaas parity operation **Criar assinatura com cartão de crédito**.\n\nThis route is implemented by `SubscriptionsController.create`.", "operationId": "criar-nova-assinatura", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "SubscriptionsController.create", "x-duckledger-source": "apps/api/src/modules/subscriptions/subscriptions.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } }, "x-duckledger-permission": "subscriptions.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/subscriptions", "url": "https://docs.asaas.com/reference/criar-nova-assinatura", "operation": "Criar nova assinatura" }, { "method": "POST", "path": "/v3/subscriptions/", "url": "https://docs.asaas.com/reference/criar-assinatura-com-cartao-de-credito", "operation": "Criar assinatura com cartão de crédito" } ] } }, "/api/v1/subscriptions/{id}/cancel": { "post": { "tags": [ "Assinaturas", "subscriptions" ], "summary": "Remover assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/subscriptions/{id}` capability.\n\nThis route is implemented by `SubscriptionsController.cancel`.", "operationId": "remover-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "SubscriptionsController.cancel", "x-duckledger-source": "apps/api/src/modules/subscriptions/subscriptions.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "x-duckledger-permission": "subscriptions.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/subscriptions/{id}", "url": "https://docs.asaas.com/reference/remover-assinatura", "operation": "Remover assinatura" } ] } }, "/api/v1/subscriptions/{id}": { "get": { "tags": [ "Assinaturas", "subscriptions" ], "summary": "Recuperar uma única assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}` capability.\n\nThis route is implemented by `SubscriptionsController.getById`.", "operationId": "recuperar-uma-unica-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "SubscriptionsController.getById", "x-duckledger-source": "apps/api/src/modules/subscriptions/subscriptions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ], "x-duckledger-permission": "subscriptions.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-assinatura", "operation": "Recuperar uma única assinatura" } ] }, "put": { "tags": [ "Assinaturas" ], "summary": "Atualizar assinatura existente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/subscriptions/{id}` capability.", "operationId": "atualizar-assinatura-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/subscriptions/{id}", "url": "https://docs.asaas.com/reference/atualizar-assinatura-existente", "operation": "Atualizar assinatura existente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } }, "patch": { "tags": [ "subscriptions" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-subscriptions-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SubscriptionsController.update", "x-duckledger-source": "apps/api/src/modules/subscriptions/subscriptions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/subscriptions/{id}/creditCard": { "put": { "tags": [ "Assinaturas" ], "summary": "Atualiza o cartão de crédito sem efetuar cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/subscriptions/{id}/creditCard` capability.", "operationId": "atualizar-cartao-de-credito-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/subscriptions/{id}/creditCard", "url": "https://docs.asaas.com/reference/atualizar-cartao-de-credito-assinatura", "operation": "Atualiza o cartão de crédito sem efetuar cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions/{id}/invoices": { "get": { "tags": [ "Assinaturas" ], "summary": "Listar notas fiscais das cobranças de uma assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/invoices` capability.", "operationId": "listar-notas-fiscais-das-cobrancas-de-uma-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/invoices", "url": "https://docs.asaas.com/reference/listar-notas-fiscais-das-cobrancas-de-uma-assinatura", "operation": "Listar notas fiscais das cobranças de uma assinatura" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/subscriptions/{id}/invoiceSettings": { "delete": { "tags": [ "Assinaturas" ], "summary": "Remover configuração para emissão de Notas Fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "remover-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/remover-configuracao-para-emissao-de-notas-fiscais", "operation": "Remover configuração para emissão de Notas Fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Assinaturas" ], "summary": "Recuperar configuração para emissão de notas fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "recuperar-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/recuperar-configuracao-para-emissao-de-notas-fiscais", "operation": "Recuperar configuração para emissão de notas fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Assinaturas" ], "summary": "Criar configuração para emissão de Notas Fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "criar-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/criar-configuracao-para-emissao-de-notas-fiscais", "operation": "Criar configuração para emissão de Notas Fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } }, "put": { "tags": [ "Assinaturas" ], "summary": "Atualizar configuração para emissão de Notas Fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "atualizar-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/atualizar-configuracao-para-emissao-de-notas-fiscais", "operation": "Atualizar configuração para emissão de Notas Fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions/{id}/paymentBook": { "get": { "tags": [ "Assinaturas" ], "summary": "Gerar carnê de assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/paymentBook` capability.", "operationId": "gerar-carne-de-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/paymentBook", "url": "https://docs.asaas.com/reference/gerar-carne-de-assinatura", "operation": "Gerar carnê de assinatura" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/subscriptions/{id}/payments": { "get": { "tags": [ "Assinaturas" ], "summary": "Listar cobranças de uma assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/payments` capability.", "operationId": "listar-cobrancas-de-uma-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/payments", "url": "https://docs.asaas.com/reference/listar-cobrancas-de-uma-assinatura", "operation": "Listar cobranças de uma assinatura" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/creditCard/preAuthorization/config": { "get": { "tags": [ "Cartão de crédito" ], "summary": "Recuperar configuração da pré-autorização", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/creditCard/preAuthorization/config` capability.", "operationId": "recuperar-configuracao-de-pre-autorizacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/creditCard/preAuthorization/config", "url": "https://docs.asaas.com/reference/recuperar-configuracao-de-pre-autorizacao", "operation": "Recuperar configuração da pré-autorização" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Cartão de crédito" ], "summary": "Salvar ou atualizar configuração da pré-autorização", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/creditCard/preAuthorization/config` capability.", "operationId": "salvar-ou-atualizar-configuracao-de-pre-autorizacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/creditCard/preAuthorization/config", "url": "https://docs.asaas.com/reference/salvar-ou-atualizar-configuracao-de-pre-autorizacao", "operation": "Salvar ou atualizar configuração da pré-autorização" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payment-methods/tokenize": { "post": { "tags": [ "Cartão de crédito", "payment-methods" ], "summary": "Tokenização de cartão de crédito", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/creditCard/tokenizeCreditCard` capability.\n\nThis route is implemented by `PaymentMethodsController.tokenize`.", "operationId": "tokenizacao-de-cartao-de-credito", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentMethodsController.tokenize", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } }, "x-duckledger-permission": "payments.create", "x-asaas-source": [ { "method": "POST", "path": "/v3/creditCard/tokenizeCreditCard", "url": "https://docs.asaas.com/reference/tokenizacao-de-cartao-de-credito", "operation": "Tokenização de cartão de crédito" } ] } }, "/api/v1/chargebacks": { "get": { "tags": [ "Chargeback" ], "summary": "Listar chargebacks", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/chargebacks/` capability.", "operationId": "listar-chargebacks", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/chargebacks/", "url": "https://docs.asaas.com/reference/listar-chargebacks", "operation": "Listar chargebacks" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/chargebacks/{id}/dispute": { "post": { "tags": [ "Chargeback" ], "summary": "Criar disputa de chargeback", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/chargebacks/{id}/dispute` capability.", "operationId": "criar-disputa-de-chargeback", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/chargebacks/{id}/dispute", "url": "https://docs.asaas.com/reference/criar-disputa-de-chargeback", "operation": "Criar disputa de chargeback" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/chargeback": { "get": { "tags": [ "Chargeback" ], "summary": "Recuperar um único chargeback", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/chargeback` capability.", "operationId": "recuperar-um-unico-chargeback", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/chargeback", "url": "https://docs.asaas.com/reference/recuperar-um-unico-chargeback", "operation": "Recuperar um único chargeback" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/checkouts": { "post": { "tags": [ "Checkout" ], "summary": "Criar novo checkout", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/checkouts` capability.", "operationId": "criar-novo-checkout", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/checkouts", "url": "https://docs.asaas.com/reference/criar-novo-checkout", "operation": "Criar novo checkout" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/checkouts/{id}/cancel": { "post": { "tags": [ "Checkout" ], "summary": "Cancelar um checkout", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/checkouts/{id}/cancel` capability.", "operationId": "cancelar-um-checkout", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/checkouts/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-um-checkout", "operation": "Cancelar um checkout" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/customers": { "get": { "tags": [ "Clientes", "customers" ], "summary": "Listar clientes", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/customers` capability.\n\nThis route is implemented by `CustomersController.list`.", "operationId": "listar-clientes", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "CustomersController.list", "x-duckledger-source": "apps/api/src/modules/customers/customers.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ], "x-duckledger-permission": "payments.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/customers", "url": "https://docs.asaas.com/reference/listar-clientes", "operation": "Listar clientes" } ] }, "post": { "tags": [ "Clientes", "customers" ], "summary": "Criar novo cliente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/customers` capability.\n\nThis route is implemented by `CustomersController.create`.", "operationId": "criar-novo-cliente", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "CustomersController.create", "x-duckledger-source": "apps/api/src/modules/customers/customers.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } }, "x-duckledger-permission": "payments.create", "x-asaas-source": [ { "method": "POST", "path": "/v3/customers", "url": "https://docs.asaas.com/reference/criar-novo-cliente", "operation": "Criar novo cliente" } ] } }, "/api/v1/customers/{id}": { "delete": { "tags": [ "Clientes" ], "summary": "Remover cliente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/customers/{id}` capability.", "operationId": "remover-cliente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/customers/{id}", "url": "https://docs.asaas.com/reference/remover-cliente", "operation": "Remover cliente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Clientes", "customers" ], "summary": "Recuperar um único cliente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/customers/{id}` capability.\n\nThis route is implemented by `CustomersController.getById`.", "operationId": "recuperar-um-unico-cliente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "CustomersController.getById", "x-duckledger-source": "apps/api/src/modules/customers/customers.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ], "x-duckledger-permission": "payments.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/customers/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-cliente", "operation": "Recuperar um único cliente" } ] }, "put": { "tags": [ "Clientes" ], "summary": "Atualizar cliente existente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/customers/{id}` capability.", "operationId": "atualizar-cliente-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/customers/{id}", "url": "https://docs.asaas.com/reference/atualizar-cliente-existente", "operation": "Atualizar cliente existente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/customers/{id}/notifications": { "get": { "tags": [ "Clientes" ], "summary": "Recuperar notificações de um cliente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/customers/{id}/notifications` capability.", "operationId": "recuperar-notificacoes-de-um-cliente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/customers/{id}/notifications", "url": "https://docs.asaas.com/reference/recuperar-notificacoes-de-um-cliente", "operation": "Recuperar notificações de um cliente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/customers/{id}/restore": { "post": { "tags": [ "Clientes" ], "summary": "Restaurar cliente removido", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/customers/{id}/restore` capability.", "operationId": "restaurar-cliente-removido", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/customers/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-cliente-removido", "operation": "Restaurar cliente removido" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments": { "get": { "tags": [ "Cobranças", "payments" ], "summary": "Listar cobranças", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments` capability.\n\nThis route is implemented by `PaymentsController.list`.", "operationId": "listar-cobrancas", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentsController.list", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ], "x-duckledger-permission": "payments.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments", "url": "https://docs.asaas.com/reference/listar-cobrancas", "operation": "Listar cobranças" } ] }, "post": { "tags": [ "Cobranças", "payments" ], "summary": "Criar nova cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments` capability.\n\nAlso covers the Asaas parity operation **Criar cobrança com cartão de crédito**.\n\nThis route is implemented by `PaymentsController.create`.", "operationId": "criar-nova-cobranca", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentsController.create", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } }, "x-duckledger-permission": "payments.create", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments", "url": "https://docs.asaas.com/reference/criar-nova-cobranca", "operation": "Criar nova cobrança" }, { "method": "POST", "path": "/v3/payments/", "url": "https://docs.asaas.com/reference/criar-cobranca-com-cartao-de-credito", "operation": "Criar cobrança com cartão de crédito" } ] } }, "/api/v1/payments/{id}/cancel": { "post": { "tags": [ "Cobranças", "payments" ], "summary": "Excluir cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/payments/{id}` capability.\n\nThis route is implemented by `PaymentsController.cancel`.", "operationId": "excluir-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentsController.cancel", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "x-duckledger-permission": "payments.create", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/payments/{id}", "url": "https://docs.asaas.com/reference/excluir-cobranca", "operation": "Excluir cobrança" } ] } }, "/api/v1/payments/{id}": { "get": { "tags": [ "Cobranças", "payments" ], "summary": "Recuperar uma única cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}` capability.\n\nThis route is implemented by `PaymentsController.getById`.", "operationId": "recuperar-uma-unica-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentsController.getById", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ], "x-duckledger-permission": "payments.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-cobranca", "operation": "Recuperar uma única cobrança" } ] }, "put": { "tags": [ "Cobranças" ], "summary": "Atualizar cobrança existente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/payments/{id}` capability.", "operationId": "atualizar-cobranca-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/payments/{id}", "url": "https://docs.asaas.com/reference/atualizar-cobranca-existente", "operation": "Atualizar cobrança existente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/billingInfo": { "get": { "tags": [ "Cobranças" ], "summary": "Recuperar informações de pagamento de uma cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/billingInfo` capability.", "operationId": "recuperar-informacoes-de-pagamento-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/billingInfo", "url": "https://docs.asaas.com/reference/recuperar-informacoes-de-pagamento-de-uma-cobranca", "operation": "Recuperar informações de pagamento de uma cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/{id}/captureAuthorizedPayment": { "post": { "tags": [ "Cobranças" ], "summary": "Capturar cobrança com Pré-Autorização", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/captureAuthorizedPayment` capability.", "operationId": "capturar-cobranca-com-pre-autorizacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/captureAuthorizedPayment", "url": "https://docs.asaas.com/reference/capturar-cobranca-com-pre-autorizacao", "operation": "Capturar cobrança com Pré-Autorização" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/boleto": { "get": { "tags": [ "Cobranças", "payments" ], "summary": "Obter linha digitável do boleto", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/identificationField` capability.\n\nThis route is implemented by `PaymentsController.boleto`.", "operationId": "obter-linha-digitavel-do-boleto", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentsController.boleto", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ], "x-duckledger-permission": "payments.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/identificationField", "url": "https://docs.asaas.com/reference/obter-linha-digitavel-do-boleto", "operation": "Obter linha digitável do boleto" } ] } }, "/api/v1/payments/{id}/payWithCard": { "post": { "tags": [ "Cobranças" ], "summary": "Pagar uma cobrança com cartão", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/payWithCard` capability.", "operationId": "pagar-uma-cobranca-com-cartao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/payWithCard", "url": "https://docs.asaas.com/reference/pagar-uma-cobranca-com-cartao", "operation": "Pagar uma cobrança com cartão" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/payWithCreditCard": { "post": { "tags": [ "Cobranças" ], "summary": "Pagar uma cobrança com cartão de crédito", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/payWithCreditCard` capability.", "operationId": "pagar-uma-cobranca-com-cartao-de-credito", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/payWithCreditCard", "url": "https://docs.asaas.com/reference/pagar-uma-cobranca-com-cartao-de-credito", "operation": "Pagar uma cobrança com cartão de crédito" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/pix": { "get": { "tags": [ "Cobranças", "payments" ], "summary": "Obter QR Code para pagamentos via Pix", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/pixQrCode` capability.\n\nThis route is implemented by `PaymentsController.pix`.", "operationId": "obter-qr-code-para-pagamentos-via-pix", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentsController.pix", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ], "x-duckledger-permission": "payments.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/pixQrCode", "url": "https://docs.asaas.com/reference/obter-qr-code-para-pagamentos-via-pix", "operation": "Obter QR Code para pagamentos via Pix" } ] } }, "/api/v1/payments/{id}/receiveInCash": { "post": { "tags": [ "Cobranças" ], "summary": "Confirmar recebimento em dinheiro", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/receiveInCash` capability.", "operationId": "confirmar-recebimento-em-dinheiro", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/receiveInCash", "url": "https://docs.asaas.com/reference/confirmar-recebimento-em-dinheiro", "operation": "Confirmar recebimento em dinheiro" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/refund": { "post": { "tags": [ "Cobranças", "payments" ], "summary": "Estornar cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/refund` capability.\n\nThis route is implemented by `PaymentsController.refund`.", "operationId": "estornar-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PaymentsController.refund", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.refund" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } }, "x-duckledger-permission": "payments.refund", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/refund", "url": "https://docs.asaas.com/reference/estornar-cobranca", "operation": "Estornar cobrança" } ] } }, "/api/v1/payments/{id}/restore": { "post": { "tags": [ "Cobranças" ], "summary": "Restaurar cobrança removida", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/restore` capability.", "operationId": "restaurar-cobranca-removida", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-cobranca-removida", "operation": "Restaurar cobrança removida" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/status": { "get": { "tags": [ "Cobranças" ], "summary": "Recuperar status de uma cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/status` capability.", "operationId": "recuperar-status-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/status", "url": "https://docs.asaas.com/reference/recuperar-status-de-uma-cobranca", "operation": "Recuperar status de uma cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/{id}/undoReceivedInCash": { "post": { "tags": [ "Cobranças" ], "summary": "Desfazer confirmação de recebimento em dinheiro", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/undoReceivedInCash` capability.", "operationId": "desfazer-confirmacao-de-recebimento-em-dinheiro", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/undoReceivedInCash", "url": "https://docs.asaas.com/reference/desfazer-confirmacao-de-recebimento-em-dinheiro", "operation": "Desfazer confirmação de recebimento em dinheiro" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/viewingInfo": { "get": { "tags": [ "Cobranças" ], "summary": "Informações sobre visualização da cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/viewingInfo` capability.", "operationId": "informacoes-sobre-visualizacao-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/viewingInfo", "url": "https://docs.asaas.com/reference/informacoes-sobre-visualizacao-da-cobranca", "operation": "Informações sobre visualização da cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/limits": { "get": { "tags": [ "Cobranças" ], "summary": "Recuperando limites de cobranças", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/limits` capability.", "operationId": "recuperando-limites-de-cobrancas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/limits", "url": "https://docs.asaas.com/reference/recuperando-limites-de-cobrancas-1", "operation": "Recuperando limites de cobranças" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/simulate": { "post": { "tags": [ "Cobranças" ], "summary": "Simulador de vendas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/simulate` capability.", "operationId": "simulador-de-vendas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/simulate", "url": "https://docs.asaas.com/reference/simulador-de-vendas", "operation": "Simulador de vendas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments": { "get": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Listar cobranças com dados resumidos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/lean/payments` capability.", "operationId": "listar-cobrancas-com-dados-resumidos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/lean/payments", "url": "https://docs.asaas.com/reference/listar-cobrancas-com-dados-resumidos", "operation": "Listar cobranças com dados resumidos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Criar nova cobrança com dados resumidos na resposta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/lean/payments` capability.\n\nAlso covers the Asaas parity operation **Criar cobrança com cartão de crédito com dados resumidos na resposta**.", "operationId": "criar-nova-cobranca-com-dados-resumidos-na-resposta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments", "url": "https://docs.asaas.com/reference/criar-nova-cobranca-com-dados-resumidos-na-resposta", "operation": "Criar nova cobrança com dados resumidos na resposta" }, { "method": "POST", "path": "/v3/lean/payments/", "url": "https://docs.asaas.com/reference/criar-cobranca-com-cartao-de-credito-com-dados-resumidos-na-resposta", "operation": "Criar cobrança com cartão de crédito com dados resumidos na resposta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}": { "delete": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Excluir cobrança com dados resumidos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/lean/payments/{id}` capability.", "operationId": "excluir-cobranca-com-dados-resumidos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/lean/payments/{id}", "url": "https://docs.asaas.com/reference/excluir-cobranca-com-dados-resumidos", "operation": "Excluir cobrança com dados resumidos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Recuperar uma única cobrança com dados resumidos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/lean/payments/{id}` capability.", "operationId": "recuperar-uma-unica-cobranca-com-dados-resumidos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/lean/payments/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-cobranca-com-dados-resumidos", "operation": "Recuperar uma única cobrança com dados resumidos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Atualizar cobrança existente com dados resumidos na resposta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/lean/payments/{id}` capability.", "operationId": "atualizar-cobranca-existente-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/lean/payments/{id}", "url": "https://docs.asaas.com/reference/atualizar-cobranca-existente-com-dados-resumidos-na-resposta", "operation": "Atualizar cobrança existente com dados resumidos na resposta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/captureAuthorizedPayment": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Capturar cobrança com Pré-Autorização com dados resumidos na resposta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/captureAuthorizedPayment` capability.", "operationId": "capturar-cobranca-com-pre-autorizacao-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/captureAuthorizedPayment", "url": "https://docs.asaas.com/reference/capturar-cobranca-com-pre-autorizacao-com-dados-resumidos-na-resposta", "operation": "Capturar cobrança com Pré-Autorização com dados resumidos na resposta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/receiveInCash": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Confirmar recebimento em dinheiro com dados resumidos na resposta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/receiveInCash` capability.", "operationId": "confirmar-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/receiveInCash", "url": "https://docs.asaas.com/reference/confirmar-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "operation": "Confirmar recebimento em dinheiro com dados resumidos na resposta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/refund": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Estornar cobrança com dados resumidos na resposta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/refund` capability.", "operationId": "estornar-cobranca-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/refund", "url": "https://docs.asaas.com/reference/estornar-cobranca-com-dados-resumidos-na-resposta", "operation": "Estornar cobrança com dados resumidos na resposta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/restore": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Restaurar cobrança removida com dados resumidos na resposta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/restore` capability.", "operationId": "restaurar-cobranca-removida-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-cobranca-removida-com-dados-resumidos-na-resposta", "operation": "Restaurar cobrança removida com dados resumidos na resposta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/undoReceivedInCash": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Desfazer confirmação de recebimento em dinheiro com dados resumidos na resposta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/undoReceivedInCash` capability.", "operationId": "desfazer-confirmacao-de-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/undoReceivedInCash", "url": "https://docs.asaas.com/reference/desfazer-confirmacao-de-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "operation": "Desfazer confirmação de recebimento em dinheiro com dados resumidos na resposta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/webhook-endpoints": { "get": { "tags": [ "Configurações de Webhooks", "webhook-endpoints" ], "summary": "Listar webhooks", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/webhooks` capability.\n\nThis route is implemented by `WebhookEndpointsController.list`.", "operationId": "listar-webhooks", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhookEndpointsController.list", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.read" ], "x-duckledger-permission": "webhooks.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/webhooks", "url": "https://docs.asaas.com/reference/listar-webhooks", "operation": "Listar webhooks" } ] }, "post": { "tags": [ "Configurações de Webhooks", "webhook-endpoints" ], "summary": "Criar novo webhook", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/webhooks` capability.\n\nThis route is implemented by `WebhookEndpointsController.create`.", "operationId": "criar-novo-webhook", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhookEndpointsController.create", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } }, "x-duckledger-permission": "webhooks.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/webhooks", "url": "https://docs.asaas.com/reference/criar-novo-webhook", "operation": "Criar novo webhook" } ] } }, "/api/v1/webhook-endpoints/{id}": { "delete": { "tags": [ "Configurações de Webhooks", "webhook-endpoints" ], "summary": "Remover um webhook", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/webhooks/{id}` capability.\n\nThis route is implemented by `WebhookEndpointsController.remove`.", "operationId": "remover-webhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhookEndpointsController.remove", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.manage" ], "x-duckledger-permission": "webhooks.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/webhooks/{id}", "url": "https://docs.asaas.com/reference/remover-webhook", "operation": "Remover um webhook" } ] }, "patch": { "tags": [ "Configurações de Webhooks", "webhook-endpoints" ], "summary": "Atualizar webhook existente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/webhooks/{id}` capability.\n\nThis route is implemented by `WebhookEndpointsController.update`.", "operationId": "atualizar-webhook-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhookEndpointsController.update", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } }, "x-duckledger-permission": "webhooks.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/webhooks/{id}", "url": "https://docs.asaas.com/reference/atualizar-webhook-existente", "operation": "Atualizar webhook existente" } ] } }, "/api/v1/webhooks/{id}": { "get": { "tags": [ "Configurações de Webhooks" ], "summary": "Recuperar um único webhook", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/webhooks/{id}` capability.", "operationId": "recuperar-um-unico-webhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/webhooks/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-webhook", "operation": "Recuperar um único webhook" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/webhooks/{id}/removeBackoff": { "post": { "tags": [ "Configurações de Webhooks" ], "summary": "Remover penalização de webhook", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/webhooks/{id}/removeBackoff` capability.", "operationId": "remover-penalizacao-webhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/webhooks/{id}/removeBackoff", "url": "https://docs.asaas.com/reference/remover-penalizacao-webhook", "operation": "Remover penalização de webhook" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/creditBureauReport": { "get": { "tags": [ "Consulta Serasa" ], "summary": "Listar consultas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/creditBureauReport` capability.", "operationId": "listar-consultas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/creditBureauReport", "url": "https://docs.asaas.com/reference/listar-consultas-1", "operation": "Listar consultas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Consulta Serasa" ], "summary": "Realizar consulta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/creditBureauReport` capability.", "operationId": "realizar-consulta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/creditBureauReport", "url": "https://docs.asaas.com/reference/realizar-consulta", "operation": "Realizar consulta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/creditBureauReport/{id}": { "get": { "tags": [ "Consulta Serasa" ], "summary": "Recuperar uma consulta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/creditBureauReport/{id}` capability.", "operationId": "recuperar-uma-consulta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/creditBureauReport/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-consulta-1", "operation": "Recuperar uma consulta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/accounts/{id}/escrow": { "get": { "tags": [ "Conta Escrow" ], "summary": "Recuperar configuração da Conta Escrow para a subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/accounts/{id}/escrow` capability.", "operationId": "recuperar-configuracao-da-conta-escrow-para-a-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/{id}/escrow", "url": "https://docs.asaas.com/reference/recuperar-configuracao-da-conta-escrow-para-a-subconta", "operation": "Recuperar configuração da Conta Escrow para a subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Conta Escrow" ], "summary": "Salvar ou atualizar configuração da Conta Escrow para a subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/accounts/{id}/escrow` capability.", "operationId": "salvar-ou-atualizar-configuracao-da-conta-escrow-para-a-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/{id}/escrow", "url": "https://docs.asaas.com/reference/salvar-ou-atualizar-configuracao-da-conta-escrow-para-a-subconta", "operation": "Salvar ou atualizar configuração da Conta Escrow para a subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/escrow": { "get": { "tags": [ "Conta Escrow" ], "summary": "Recuperar configuração padrão da Conta Escrow", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/accounts/escrow` capability.", "operationId": "recuperar-configuracao-padrao-da-conta-escrow", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/escrow", "url": "https://docs.asaas.com/reference/recuperar-configuracao-padrao-da-conta-escrow", "operation": "Recuperar configuração padrão da Conta Escrow" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Conta Escrow" ], "summary": "Criar configuração padrão da Conta Escrow para todas as subcontas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/accounts/escrow` capability.", "operationId": "criar-configuracao-padrao-da-conta-escrow-para-todas-as-subcontas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/escrow", "url": "https://docs.asaas.com/reference/criar-configuracao-padrao-da-conta-escrow-para-todas-as-subcontas", "operation": "Criar configuração padrão da Conta Escrow para todas as subcontas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/escrow/{id}/finish": { "post": { "tags": [ "Conta Escrow" ], "summary": "Encerrar garantia da cobrança na Conta Escrow", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/escrow/{id}/finish` capability.", "operationId": "encerrar-garantia-da-cobranca-na-conta-escrow", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/escrow/{id}/finish", "url": "https://docs.asaas.com/reference/encerrar-garantia-da-cobranca-na-conta-escrow", "operation": "Encerrar garantia da cobrança na Conta Escrow" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/escrow": { "get": { "tags": [ "Conta Escrow" ], "summary": "Recuperar garantia da cobrança na Conta Escrow", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/escrow` capability.", "operationId": "recuperar-garantia-da-cobranca-na-conta-escrow", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/escrow", "url": "https://docs.asaas.com/reference/recuperar-garantia-da-cobranca-na-conta-escrow", "operation": "Recuperar garantia da cobrança na Conta Escrow" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/{id}/documents": { "get": { "tags": [ "Documentos de cobranças" ], "summary": "Listar documentos de uma cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/documents` capability.", "operationId": "listar-documentos-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/documents", "url": "https://docs.asaas.com/reference/listar-documentos-de-uma-cobranca", "operation": "Listar documentos de uma cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Documentos de cobranças" ], "summary": "Fazer upload de documentos da cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/documents` capability.", "operationId": "fazer-upload-de-documentos-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/documents", "url": "https://docs.asaas.com/reference/fazer-upload-de-documentos-da-cobranca", "operation": "Fazer upload de documentos da cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/documents/{documentId}": { "delete": { "tags": [ "Documentos de cobranças" ], "summary": "Excluir documento de uma cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/payments/{id}/documents/{documentId}` capability.", "operationId": "excluir-documento-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "documentId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/payments/{id}/documents/{documentId}", "url": "https://docs.asaas.com/reference/excluir-documento-de-uma-cobranca", "operation": "Excluir documento de uma cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Documentos de cobranças" ], "summary": "Recuperar um único documento da cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/documents/{documentId}` capability.", "operationId": "recuperar-um-unico-documento-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "documentId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/documents/{documentId}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-documento-da-cobranca", "operation": "Recuperar um único documento da cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Documentos de cobranças" ], "summary": "Atualizar definições de um documento da cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/payments/{id}/documents/{documentId}` capability.", "operationId": "atualizar-definicoes-de-um-documento-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "documentId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/payments/{id}/documents/{documentId}", "url": "https://docs.asaas.com/reference/atualizar-definicoes-de-um-documento-da-cobranca", "operation": "Atualizar definições de um documento da cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/myAccount/documents": { "get": { "tags": [ "Envio de documentos White Label" ], "summary": "Verificar documentos pendentes", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/myAccount/documents` capability.", "operationId": "verificar-documentos-pendentes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/documents", "url": "https://docs.asaas.com/reference/verificar-documentos-pendentes", "operation": "Verificar documentos pendentes" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/myAccount/documents/{id}": { "post": { "tags": [ "Envio de documentos White Label" ], "summary": "Enviar documentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/myAccount/documents/{id}` capability.", "operationId": "enviar-documentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/myAccount/documents/{id}", "url": "https://docs.asaas.com/reference/enviar-documentos", "operation": "Enviar documentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/myAccount/documents/files/{id}": { "delete": { "tags": [ "Envio de documentos White Label" ], "summary": "Remover documento enviado", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/myAccount/documents/files/{id}` capability.", "operationId": "remover-documento-enviado", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/myAccount/documents/files/{id}", "url": "https://docs.asaas.com/reference/remover-documento-enviado", "operation": "Remover documento enviado" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Envio de documentos White Label" ], "summary": "Visualizar documento enviado", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/myAccount/documents/files/{id}` capability.", "operationId": "visualizar-documento-enviado", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/documents/files/{id}", "url": "https://docs.asaas.com/reference/visualizar-documento-enviado", "operation": "Visualizar documento enviado" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Envio de documentos White Label" ], "summary": "Atualizar documento enviado", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/myAccount/documents/files/{id}` capability.", "operationId": "atualizar-documento-enviado", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/myAccount/documents/files/{id}", "url": "https://docs.asaas.com/reference/atualizar-documento-enviado", "operation": "Atualizar documento enviado" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/bankSlip/refund": { "post": { "tags": [ "Estornos" ], "summary": "Estornar boleto", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/bankSlip/refund` capability.", "operationId": "estornar-boleto", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/bankSlip/refund", "url": "https://docs.asaas.com/reference/estornar-boleto", "operation": "Estornar boleto" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/refunds": { "get": { "tags": [ "Estornos" ], "summary": "Listar estornos de uma cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/refunds` capability.", "operationId": "listar-estornos-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/refunds", "url": "https://docs.asaas.com/reference/listar-estornos-de-uma-cobranca", "operation": "Listar estornos de uma cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/financialTransactions": { "get": { "tags": [ "Extrato" ], "summary": "Recuperar extrato", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/financialTransactions` capability.", "operationId": "recuperar-extrato", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/financialTransactions", "url": "https://docs.asaas.com/reference/recuperar-extrato", "operation": "Recuperar extrato" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/myAccount": { "delete": { "tags": [ "Informações e personalização da conta" ], "summary": "Excluir subconta White Label", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/myAccount/` capability.", "operationId": "excluir-subconta-white-label", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/myAccount/", "url": "https://docs.asaas.com/reference/excluir-subconta-baas", "operation": "Excluir subconta White Label" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/myAccount/accountNumber": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar número de conta no Asaas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/myAccount/accountNumber` capability.", "operationId": "recuperar-numero-de-conta-no-asaas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/accountNumber", "url": "https://docs.asaas.com/reference/recuperar-numero-de-conta-no-asaas", "operation": "Recuperar número de conta no Asaas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/myAccount/commercialInfo": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar dados comerciais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/myAccount/commercialInfo/` capability.", "operationId": "recuperar-dados-comerciais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/commercialInfo/", "url": "https://docs.asaas.com/reference/recuperar-dados-comerciais", "operation": "Recuperar dados comerciais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Informações e personalização da conta" ], "summary": "Atualizar dados comerciais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/myAccount/commercialInfo/` capability.", "operationId": "atualizar-dados-comerciais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/myAccount/commercialInfo/", "url": "https://docs.asaas.com/reference/atualizar-dados-comerciais", "operation": "Atualizar dados comerciais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/myAccount/fees": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar taxas da conta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/myAccount/fees/` capability.", "operationId": "recuperar-taxas-da-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/fees/", "url": "https://docs.asaas.com/reference/recuperar-taxas-da-conta", "operation": "Recuperar taxas da conta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/myAccount/paymentCheckoutConfig": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar configurações de personalização", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/myAccount/paymentCheckoutConfig/` capability.", "operationId": "recuperar-configuracoes-de-personalizacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/paymentCheckoutConfig/", "url": "https://docs.asaas.com/reference/recuperar-configuracoes-de-personalizacao", "operation": "Recuperar configurações de personalização" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Informações e personalização da conta" ], "summary": "Salvar personalização da fatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/myAccount/paymentCheckoutConfig/` capability.", "operationId": "salvar-personalizacao-da-fatura", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/myAccount/paymentCheckoutConfig/", "url": "https://docs.asaas.com/reference/salvar-personalizacao-da-fatura", "operation": "Salvar personalização da fatura" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/myAccount/status": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Consultar situação cadastral da conta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/myAccount/status/` capability.", "operationId": "consultar-situacao-cadastral-da-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/status/", "url": "https://docs.asaas.com/reference/consultar-situacao-cadastral-da-conta", "operation": "Consultar situação cadastral da conta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/wallets": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar WalletId", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/wallets/` capability.", "operationId": "recuperar-walletid", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/wallets/", "url": "https://docs.asaas.com/reference/recuperar-walletid", "operation": "Recuperar WalletId" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/finance/balance": { "get": { "tags": [ "Informações financeiras" ], "summary": "Recuperar saldo da conta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/finance/balance` capability.", "operationId": "recuperar-saldo-da-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/finance/balance", "url": "https://docs.asaas.com/reference/recuperar-saldo-da-conta", "operation": "Recuperar saldo da conta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/finance/payment/statistics": { "get": { "tags": [ "Informações financeiras" ], "summary": "Estatísticas de cobranças", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/finance/payment/statistics` capability.", "operationId": "estatisticas-de-cobrancas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/finance/payment/statistics", "url": "https://docs.asaas.com/reference/estatisticas-de-cobrancas", "operation": "Estatísticas de cobranças" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/finance/split/statistics": { "get": { "tags": [ "Informações financeiras" ], "summary": "Recuperar valores de split", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/finance/split/statistics` capability.", "operationId": "recuperar-valores-de-split", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/finance/split/statistics", "url": "https://docs.asaas.com/reference/recuperar-valores-de-split", "operation": "Recuperar valores de split" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/fiscalInfo": { "get": { "tags": [ "Informações fiscais" ], "summary": "Recuperar informações fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/` capability.", "operationId": "recuperar-informacoes-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/", "url": "https://docs.asaas.com/reference/recuperar-informacoes-fiscais", "operation": "Recuperar informações fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Informações fiscais" ], "summary": "Criar e atualizar informações fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/fiscalInfo/` capability.", "operationId": "criar-e-atualizar-informacoes-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/fiscalInfo/", "url": "https://docs.asaas.com/reference/criar-e-atualizar-informacoes-fiscais", "operation": "Criar e atualizar informações fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/fiscalInfo/federalServiceCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de serviços federais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/federalServiceCodes` capability.", "operationId": "listar-codigos-servicos-federais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/federalServiceCodes", "url": "https://docs.asaas.com/reference/listar-codigos-servicos-federais", "operation": "Listar códigos de serviços federais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/fiscalInfo/municipalOptions": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar configurações municipais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/municipalOptions` capability.", "operationId": "listar-configuracoes-municipais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/municipalOptions", "url": "https://docs.asaas.com/reference/listar-configuracoes-municipais", "operation": "Listar configurações municipais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/fiscalInfo/nationalPortal": { "post": { "tags": [ "Informações fiscais" ], "summary": "Configurar portal emissor de notas fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/fiscalInfo/nationalPortal` capability.", "operationId": "configurar-portal-emissor-de-notas-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/fiscalInfo/nationalPortal", "url": "https://docs.asaas.com/reference/configurar-portal-emissor-de-notas-fiscais", "operation": "Configurar portal emissor de notas fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/fiscalInfo/nbsCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos NBS", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/nbsCodes` capability.", "operationId": "listar-codigos-nbs", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/nbsCodes", "url": "https://docs.asaas.com/reference/listar-codigos-nbs", "operation": "Listar códigos NBS" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/fiscalInfo/operationIndicatorCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de indicadores de operações", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/operationIndicatorCodes` capability.", "operationId": "listar-codigos-de-operadores-de-indicacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/operationIndicatorCodes", "url": "https://docs.asaas.com/reference/listar-codigos-de-operadores-de-indicacoes", "operation": "Listar códigos de indicadores de operações" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/fiscalInfo/services": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar serviços municipais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/services` capability.", "operationId": "listar-servicos-municipais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/services", "url": "https://docs.asaas.com/reference/listar-servicos-municipais", "operation": "Listar serviços municipais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/fiscalInfo/taxClassificationCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de classificações tributárias", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/taxClassificationCodes` capability.", "operationId": "listar-codigos-de-classificacoes-tributarias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/taxClassificationCodes", "url": "https://docs.asaas.com/reference/listar-codigos-de-classificacoes-tributarias", "operation": "Listar códigos de classificações tributárias" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/fiscalInfo/taxSituationCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de situações tributárias", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/fiscalInfo/taxSituationCodes` capability.", "operationId": "listar-codigos-de-situacoes-tributarias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/taxSituationCodes", "url": "https://docs.asaas.com/reference/listar-codigos-de-situacoes-tributarias", "operation": "Listar códigos de situações tributárias" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/paymentLinks": { "get": { "tags": [ "Link de pagamentos" ], "summary": "Listar links de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentLinks` capability.", "operationId": "listar-links-de-pagamentos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks", "url": "https://docs.asaas.com/reference/listar-links-de-pagamentos", "operation": "Listar links de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Link de pagamentos" ], "summary": "Criar um link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/paymentLinks` capability.", "operationId": "criar-um-link-de-pagamentos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentLinks", "url": "https://docs.asaas.com/reference/criar-um-link-de-pagamentos", "operation": "Criar um link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{id}": { "delete": { "tags": [ "Link de pagamentos" ], "summary": "Remover um link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/paymentLinks/{id}` capability.", "operationId": "remover-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/paymentLinks/{id}", "url": "https://docs.asaas.com/reference/remover-um-link-de-pagamentos", "operation": "Remover um link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Link de pagamentos" ], "summary": "Recuperar um único link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentLinks/{id}` capability.", "operationId": "recuperar-um-unico-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-link-de-pagamentos", "operation": "Recuperar um único link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Link de pagamentos" ], "summary": "Atualizar um link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/paymentLinks/{id}` capability.", "operationId": "atualizar-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/paymentLinks/{id}", "url": "https://docs.asaas.com/reference/atualizar-um-link-de-pagamentos", "operation": "Atualizar um link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{id}/images": { "get": { "tags": [ "Link de pagamentos" ], "summary": "Listar imagens de um link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentLinks/{id}/images` capability.", "operationId": "listar-imagens-de-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks/{id}/images", "url": "https://docs.asaas.com/reference/listar-imagens-de-um-link-de-pagamentos", "operation": "Listar imagens de um link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Link de pagamentos" ], "summary": "Adicionar uma imagem a um link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/paymentLinks/{id}/images` capability.", "operationId": "adicionar-uma-imagem-a-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentLinks/{id}/images", "url": "https://docs.asaas.com/reference/adicionar-uma-imagem-a-um-link-de-pagamentos", "operation": "Adicionar uma imagem a um link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{id}/restore": { "post": { "tags": [ "Link de pagamentos" ], "summary": "Restaurar um link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/paymentLinks/{id}/restore` capability.", "operationId": "restaurar-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentLinks/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-um-link-de-pagamentos", "operation": "Restaurar um link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{paymentLinkId}/images/{imageId}": { "delete": { "tags": [ "Link de pagamentos" ], "summary": "Remover uma imagem do link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/paymentLinks/{paymentLinkId}/images/{imageId}` capability.", "operationId": "remover-uma-imagem-do-link-de-pagamentos", "parameters": [ { "name": "paymentLinkId", "in": "path", "required": true, "description": "paymentLinkId resource identifier.", "schema": { "type": "string" } }, { "name": "imageId", "in": "path", "required": true, "description": "imageId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/paymentLinks/{paymentLinkId}/images/{imageId}", "url": "https://docs.asaas.com/reference/remover-uma-imagem-do-link-de-pagamentos", "operation": "Remover uma imagem do link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Link de pagamentos" ], "summary": "Recuperar uma única imagem do link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentLinks/{paymentLinkId}/images/{imageId}` capability.", "operationId": "recuperar-uma-unica-imagem-do-link-de-pagamentos", "parameters": [ { "name": "paymentLinkId", "in": "path", "required": true, "description": "paymentLinkId resource identifier.", "schema": { "type": "string" } }, { "name": "imageId", "in": "path", "required": true, "description": "imageId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks/{paymentLinkId}/images/{imageId}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-imagem-do-link-de-pagamentos", "operation": "Recuperar uma única imagem do link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain": { "put": { "tags": [ "Link de pagamentos" ], "summary": "Definir imagem principal do link de pagamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain` capability.", "operationId": "definir-imagem-principal-do-link-de-pagamentos", "parameters": [ { "name": "paymentLinkId", "in": "path", "required": true, "description": "paymentLinkId resource identifier.", "schema": { "type": "string" } }, { "name": "imageId", "in": "path", "required": true, "description": "imageId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain", "url": "https://docs.asaas.com/reference/definir-imagem-principal-do-link-de-pagamentos", "operation": "Definir imagem principal do link de pagamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings": { "get": { "tags": [ "Negativações" ], "summary": "Listar negativações", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentDunnings` capability.", "operationId": "listar-negativacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings", "url": "https://docs.asaas.com/reference/listar-negativacoes", "operation": "Listar negativações" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Negativações" ], "summary": "Criar uma negativação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/paymentDunnings` capability.", "operationId": "criar-uma-negativacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings", "url": "https://docs.asaas.com/reference/criar-uma-negativacao", "operation": "Criar uma negativação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings/{id}": { "get": { "tags": [ "Negativações" ], "summary": "Recuperar uma única negativação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentDunnings/{id}` capability.", "operationId": "recuperar-uma-unica-negativacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-negativacao", "operation": "Recuperar uma única negativação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/paymentDunnings/{id}/cancel": { "post": { "tags": [ "Negativações" ], "summary": "Cancelar negativação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/paymentDunnings/{id}/cancel` capability.", "operationId": "cancelar-negativacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-negativacao", "operation": "Cancelar negativação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings/{id}/documents": { "post": { "tags": [ "Negativações" ], "summary": "Reenviar documentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/paymentDunnings/{id}/documents` capability.", "operationId": "reenviar-documentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings/{id}/documents", "url": "https://docs.asaas.com/reference/reenviar-documentos", "operation": "Reenviar documentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings/{id}/history": { "get": { "tags": [ "Negativações" ], "summary": "Listar histórico de eventos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentDunnings/{id}/history` capability.", "operationId": "listar-historico-de-eventos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/{id}/history", "url": "https://docs.asaas.com/reference/listar-historico-de-eventos", "operation": "Listar histórico de eventos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/paymentDunnings/{id}/partialPayments": { "get": { "tags": [ "Negativações" ], "summary": "Listar pagamentos recebidos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentDunnings/{id}/partialPayments` capability.", "operationId": "listar-pagamentos-recebidos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/{id}/partialPayments", "url": "https://docs.asaas.com/reference/listar-pagamentos-recebidos", "operation": "Listar pagamentos recebidos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/paymentDunnings/paymentsAvailableForDunning": { "get": { "tags": [ "Negativações" ], "summary": "Listar cobranças disponíveis para negativação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/paymentDunnings/paymentsAvailableForDunning` capability.", "operationId": "listar-cobrancas-disponiveis-para-negativacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/paymentsAvailableForDunning", "url": "https://docs.asaas.com/reference/listar-cobrancas-disponiveis-para-negativacao", "operation": "Listar cobranças disponíveis para negativação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/paymentDunnings/simulate": { "post": { "tags": [ "Negativações" ], "summary": "Simular uma negativação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/paymentDunnings/simulate` capability.", "operationId": "simular-uma-negativacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings/simulate", "url": "https://docs.asaas.com/reference/simular-uma-negativacao", "operation": "Simular uma negativação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar notas fiscais", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/invoices` capability.", "operationId": "listar-notas-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/invoices", "url": "https://docs.asaas.com/reference/listar-notas-fiscais", "operation": "Listar notas fiscais" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Notas fiscais" ], "summary": "Agendar nota fiscal", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/invoices` capability.", "operationId": "agendar-nota-fiscal", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/invoices", "url": "https://docs.asaas.com/reference/agendar-nota-fiscal", "operation": "Agendar nota fiscal" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Recuperar uma única nota fiscal", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/invoices/{id}` capability.", "operationId": "recuperar-uma-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/invoices/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-nota-fiscal", "operation": "Recuperar uma única nota fiscal" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Notas fiscais" ], "summary": "Atualizar nota fiscal", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/invoices/{id}` capability.", "operationId": "atualizar-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/invoices/{id}", "url": "https://docs.asaas.com/reference/atualizar-nota-fiscal", "operation": "Atualizar nota fiscal" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices/{id}/authorize": { "post": { "tags": [ "Notas fiscais" ], "summary": "Emitir uma nota fiscal", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/invoices/{id}/authorize` capability.", "operationId": "emitir-uma-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/invoices/{id}/authorize", "url": "https://docs.asaas.com/reference/emitir-uma-nota-fiscal", "operation": "Emitir uma nota fiscal" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices/{id}/cancel": { "post": { "tags": [ "Notas fiscais" ], "summary": "Cancelar uma nota fiscal", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/invoices/{id}/cancel` capability.", "operationId": "cancelar-uma-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/invoices/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-nota-fiscal", "operation": "Cancelar uma nota fiscal" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/notifications/{id}": { "put": { "tags": [ "Notificações" ], "summary": "Atualizar notificação existente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/notifications/{id}` capability.", "operationId": "atualizar-notificacao-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/notifications/{id}", "url": "https://docs.asaas.com/reference/atualizar-notificacao-existente", "operation": "Atualizar notificação existente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/notifications/batch": { "put": { "tags": [ "Notificações" ], "summary": "Atualizar notificações existentes em lote", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/notifications/batch` capability.", "operationId": "atualizar-notificacoes-existentes-em-lote", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/notifications/batch", "url": "https://docs.asaas.com/reference/atualizar-notificacoes-existentes-em-lote", "operation": "Atualizar notificações existentes em lote" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/bill": { "get": { "tags": [ "Pagamento de contas" ], "summary": "Listar pagamento de contas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/bill` capability.", "operationId": "listar-pagamento-de-contas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/bill", "url": "https://docs.asaas.com/reference/listar-pagamento-de-contas", "operation": "Listar pagamento de contas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Pagamento de contas" ], "summary": "Criar um pagamento de conta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/bill` capability.", "operationId": "criar-um-pagamento-de-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/bill", "url": "https://docs.asaas.com/reference/criar-um-pagamento-de-conta", "operation": "Criar um pagamento de conta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/bill/{id}": { "get": { "tags": [ "Pagamento de contas" ], "summary": "Recuperar um único pagamento de conta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/bill/{id}` capability.", "operationId": "recuperar-um-unico-pagamento-de-conta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/bill/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-pagamento-de-conta", "operation": "Recuperar um único pagamento de conta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/bill/{id}/cancel": { "post": { "tags": [ "Pagamento de contas" ], "summary": "Cancelar pagamento de contas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/bill/{id}/cancel` capability.", "operationId": "cancelar-pagamento-de-contas", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/bill/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-pagamento-de-contas", "operation": "Cancelar pagamento de contas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/bill/simulate": { "post": { "tags": [ "Pagamento de contas" ], "summary": "Simular um pagamento de conta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/bill/simulate` capability.", "operationId": "simular-um-pagamento-de-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/bill/simulate", "url": "https://docs.asaas.com/reference/simular-um-pagamento-de-conta", "operation": "Simular um pagamento de conta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/installments": { "get": { "tags": [ "Parcelamentos" ], "summary": "Listar parcelamentos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/installments` capability.", "operationId": "listar-parcelamentos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments", "url": "https://docs.asaas.com/reference/listar-parcelamentos", "operation": "Listar parcelamentos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Parcelamentos" ], "summary": "Criar parcelamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/installments` capability.\n\nAlso covers the Asaas parity operation **Criar parcelamento com cartão de crédito**.", "operationId": "criar-parcelamento", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/installments", "url": "https://docs.asaas.com/reference/criar-parcelamento", "operation": "Criar parcelamento" }, { "method": "POST", "path": "/v3/installments/", "url": "https://docs.asaas.com/reference/criar-parcelamento-com-cartão-de-crédito", "operation": "Criar parcelamento com cartão de crédito" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/installments/{id}": { "delete": { "tags": [ "Parcelamentos" ], "summary": "Remover parcelamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/installments/{id}` capability.", "operationId": "remover-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/installments/{id}", "url": "https://docs.asaas.com/reference/remover-parcelamento-1", "operation": "Remover parcelamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Parcelamentos" ], "summary": "Recuperar um único parcelamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/installments/{id}` capability.", "operationId": "recuperar-um-unico-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-parcelamento", "operation": "Recuperar um único parcelamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/installments/{id}/paymentBook": { "get": { "tags": [ "Parcelamentos" ], "summary": "Gerar carnê de parcelamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/installments/{id}/paymentBook` capability.", "operationId": "gerar-carne-de-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments/{id}/paymentBook", "url": "https://docs.asaas.com/reference/gerar-carne-de-parcelamento", "operation": "Gerar carnê de parcelamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/installments/{id}/payments": { "delete": { "tags": [ "Parcelamentos" ], "summary": "Cancelar cobranças de um parcelamento (pendentes e vencidas)", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/installments/{id}/payments` capability.", "operationId": "cancelar-cobrancas-de-um-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/installments/{id}/payments", "url": "https://docs.asaas.com/reference/cancelar-cobrancas-de-um-parcelamento", "operation": "Cancelar cobranças de um parcelamento (pendentes e vencidas)" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Parcelamentos" ], "summary": "Listar cobranças de um parcelamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/installments/{id}/payments` capability.", "operationId": "listar-cobranças-de-um-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments/{id}/payments", "url": "https://docs.asaas.com/reference/listar-cobranças-de-um-parcelamento", "operation": "Listar cobranças de um parcelamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/installments/{id}/refund": { "post": { "tags": [ "Parcelamentos" ], "summary": "Estornar parcelamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/installments/{id}/refund` capability.", "operationId": "estornar-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/installments/{id}/refund", "url": "https://docs.asaas.com/reference/estornar-parcelamento", "operation": "Estornar parcelamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/installments/{id}/splits": { "put": { "tags": [ "Parcelamentos" ], "summary": "Atualizar splits do parcelamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/installments/{id}/splits` capability.", "operationId": "atualizar-splits-do-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/installments/{id}/splits", "url": "https://docs.asaas.com/reference/atualizar-splits-do-parcelamento", "operation": "Atualizar splits do parcelamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/addressKeys": { "get": { "tags": [ "Pix" ], "summary": "Listar chaves", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/addressKeys` capability.", "operationId": "listar-chaves", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/addressKeys", "url": "https://docs.asaas.com/reference/listar-chaves", "operation": "Listar chaves" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Pix" ], "summary": "Criar uma chave", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/addressKeys` capability.", "operationId": "criar-uma-chave", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/addressKeys", "url": "https://docs.asaas.com/reference/criar-uma-chave", "operation": "Criar uma chave" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/addressKeys/{id}": { "delete": { "tags": [ "Pix" ], "summary": "Remover chave", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/pix/addressKeys/{id}` capability.", "operationId": "remover-chave", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/pix/addressKeys/{id}", "url": "https://docs.asaas.com/reference/remover-chave", "operation": "Remover chave" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Pix" ], "summary": "Recuperar uma única chave", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/addressKeys/{id}` capability.", "operationId": "recuperar-uma-unica-chave", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/addressKeys/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-chave", "operation": "Recuperar uma única chave" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/addressKeys/external": { "get": { "tags": [ "Pix" ], "summary": "Consultar Chave Pix", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/addressKeys/external` capability.", "operationId": "consultar-chave-pix", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/addressKeys/external", "url": "https://docs.asaas.com/reference/consultar-chave-pix", "operation": "Consultar Chave Pix" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/qrCodes/static": { "post": { "tags": [ "Pix" ], "summary": "Criar QR Code estático", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/qrCodes/static` capability.", "operationId": "criar-qrcode-estatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/qrCodes/static", "url": "https://docs.asaas.com/reference/criar-qrcode-estatico", "operation": "Criar QR Code estático" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/qrCodes/static/{id}": { "delete": { "tags": [ "Pix" ], "summary": "Deletar QR Code estático", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/pix/qrCodes/static/{id}` capability.", "operationId": "deletar-qrcode-estatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/pix/qrCodes/static/{id}", "url": "https://docs.asaas.com/reference/deletar-qrcode-estatico", "operation": "Deletar QR Code estático" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/tokenBucket/addressKey": { "get": { "tags": [ "Pix" ], "summary": "Consulta de fichas disponíveis no balde", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/tokenBucket/addressKey` capability.", "operationId": "consulta-de-fichas-disponiveis-no-balde", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/tokenBucket/addressKey", "url": "https://docs.asaas.com/reference/consulta-de-fichas-disponiveis-no-balde", "operation": "Consulta de fichas disponíveis no balde" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/automatic/authorizations": { "get": { "tags": [ "Pix Automático" ], "summary": "Listar autorizações", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/automatic/authorizations` capability.", "operationId": "listar-autorizacoes-pix-automatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/authorizations", "url": "https://docs.asaas.com/reference/listar-autorizacoes-pix-automatico", "operation": "Listar autorizações" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Pix Automático" ], "summary": "Criar uma autorização", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/automatic/authorizations` capability.", "operationId": "criar-uma-autorizacao-pix-automatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/automatic/authorizations", "url": "https://docs.asaas.com/reference/criar-uma-autorizacao-pix-automatico", "operation": "Criar uma autorização" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/automatic/authorizations/{id}": { "delete": { "tags": [ "Pix Automático" ], "summary": "Cancelar uma autorização", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/pix/automatic/authorizations/{id}` capability.", "operationId": "cancelar-uma-autorizacao-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/pix/automatic/authorizations/{id}", "url": "https://docs.asaas.com/reference/cancelar-uma-autorizacao-pix-automatico", "operation": "Cancelar uma autorização" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Pix Automático" ], "summary": "Recuperar uma única autorização", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/automatic/authorizations/{id}` capability.", "operationId": "recuperar-uma-unica-autorizacao-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/authorizations/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-autorizacao-pix-automatico", "operation": "Recuperar uma única autorização" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/automatic/paymentInstructions": { "get": { "tags": [ "Pix Automático" ], "summary": "Listar instruções de pagamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/automatic/paymentInstructions` capability.", "operationId": "listar-instrucoes-de-pagamento-pix-automatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/paymentInstructions", "url": "https://docs.asaas.com/reference/listar-instrucoes-de-pagamento-pix-automatico", "operation": "Listar instruções de pagamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/automatic/paymentInstructions/{id}": { "get": { "tags": [ "Pix Automático" ], "summary": "Recuperar uma única instrução de pagamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/automatic/paymentInstructions/{id}` capability.", "operationId": "recuperar-uma-unica-instrucao-de-pagamento-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/paymentInstructions/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-instrucao-de-pagamento-pix-automatico", "operation": "Recuperar uma única instrução de pagamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/automatic/paymentInstructions/{id}/retries": { "post": { "tags": [ "Pix Automático" ], "summary": "Criar retentativa de instrução de pagamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/automatic/paymentInstructions/{id}/retries` capability.", "operationId": "criar-retentativa-de-instrucao-de-pagamento-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/automatic/paymentInstructions/{id}/retries", "url": "https://docs.asaas.com/reference/criar-retentativa-de-instrucao-de-pagamento-pix-automatico", "operation": "Criar retentativa de instrução de pagamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/transactions/recurrings": { "get": { "tags": [ "Pix Recorrente" ], "summary": "Listar recorrências", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/transactions/recurrings` capability.", "operationId": "listar-recorrencias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/recurrings", "url": "https://docs.asaas.com/reference/listar-recorrencias", "operation": "Listar recorrências" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/transactions/recurrings/{id}": { "get": { "tags": [ "Pix Recorrente" ], "summary": "Recuperar uma única recorrência", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/transactions/recurrings/{id}` capability.", "operationId": "recuperar-uma-unica-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/recurrings/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-recorrencia", "operation": "Recuperar uma única recorrência" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/transactions/recurrings/{id}/cancel": { "post": { "tags": [ "Pix Recorrente" ], "summary": "Cancelar uma recorrência", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/transactions/recurrings/{id}/cancel` capability.", "operationId": "cancelar-uma-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/transactions/recurrings/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-recorrencia", "operation": "Cancelar uma recorrência" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/transactions/recurrings/{id}/items": { "get": { "tags": [ "Pix Recorrente" ], "summary": "Listar itens de uma recorrência", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/transactions/recurrings/{id}/items` capability.", "operationId": "listar-itens-de-uma-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/recurrings/{id}/items", "url": "https://docs.asaas.com/reference/listar-itens-de-uma-recorrencia", "operation": "Listar itens de uma recorrência" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/transactions/recurrings/items/{id}/cancel": { "post": { "tags": [ "Pix Recorrente" ], "summary": "Cancelar item de uma recorrência", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/transactions/recurrings/items/{id}/cancel` capability.", "operationId": "cancelar-item-de-uma-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/transactions/recurrings/items/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-item-de-uma-recorrencia", "operation": "Cancelar item de uma recorrência" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/mobilePhoneRecharges": { "get": { "tags": [ "Recargas de celular" ], "summary": "Listar recargas de celular", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/mobilePhoneRecharges` capability.", "operationId": "listar-recargas-de-celular", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/mobilePhoneRecharges", "url": "https://docs.asaas.com/reference/listar-recargas-de-celular", "operation": "Listar recargas de celular" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Recargas de celular" ], "summary": "Solicitar recarga", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/mobilePhoneRecharges` capability.", "operationId": "solicitar-recarga", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/mobilePhoneRecharges", "url": "https://docs.asaas.com/reference/solicitar-recarga", "operation": "Solicitar recarga" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/mobilePhoneRecharges/{id}": { "get": { "tags": [ "Recargas de celular" ], "summary": "Recuperar uma única recarga de celular", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/mobilePhoneRecharges/{id}` capability.", "operationId": "recuperar-uma-unica-recarga-de-celular", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/mobilePhoneRecharges/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-recarga-de-celular", "operation": "Recuperar uma única recarga de celular" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/mobilePhoneRecharges/{id}/cancel": { "post": { "tags": [ "Recargas de celular" ], "summary": "Cancelar uma recarga de celular", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/mobilePhoneRecharges/{id}/cancel` capability.", "operationId": "cancelar-uma-recarga-de-celular", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/mobilePhoneRecharges/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-recarga-de-celular", "operation": "Cancelar uma recarga de celular" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/mobilePhoneRecharges/{phoneNumber}/provider": { "get": { "tags": [ "Recargas de celular" ], "summary": "Buscar qual provedor o número pertence e os valores disponíveis para recarga", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/mobilePhoneRecharges/{phoneNumber}/provider` capability.", "operationId": "buscar-qual-provedor-o-numero-pertence-e-os-valores-disponiveis-para-recarga", "parameters": [ { "name": "phoneNumber", "in": "path", "required": true, "description": "phoneNumber resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/mobilePhoneRecharges/{phoneNumber}/provider", "url": "https://docs.asaas.com/reference/buscar-qual-provedor-o-numero-pertence-e-os-valores-disponiveis-para-recarga", "operation": "Buscar qual provedor o número pertence e os valores disponíveis para recarga" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/{id}/contractualEffectRestrictions": { "get": { "tags": [ "Registro de Recebíveis" ], "summary": "Recuperar efeitos de contrato que estão bloqueando a antecipação de uma cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/contractualEffectRestrictions` capability.", "operationId": "recuperar-efeito-de-contrato-bloqueando-antecipacao-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/contractualEffectRestrictions", "url": "https://docs.asaas.com/reference/recuperar-efeito-de-contrato-bloqueando-antecipacao-da-cobranca", "operation": "Recuperar efeitos de contrato que estão bloqueando a antecipação de uma cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/splits/paid": { "get": { "tags": [ "Splits" ], "summary": "Listar splits pagos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/splits/paid` capability.", "operationId": "listar-splits-pagos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/paid", "url": "https://docs.asaas.com/reference/listar-splits-pagos", "operation": "Listar splits pagos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/splits/paid/{id}": { "get": { "tags": [ "Splits" ], "summary": "Recuperar um único split pago", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/splits/paid/{id}` capability.", "operationId": "recuperar-um-unico-split-pago", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/paid/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-split-pago", "operation": "Recuperar um único split pago" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/splits/received": { "get": { "tags": [ "Splits" ], "summary": "Listar splits recebidos", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/splits/received` capability.", "operationId": "listar-splits-recebidos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/received", "url": "https://docs.asaas.com/reference/listar-splits-recebidos", "operation": "Listar splits recebidos" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/splits/received/{id}": { "get": { "tags": [ "Splits" ], "summary": "Recuperar um único split recebido", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/splits/received/{id}` capability.", "operationId": "recuperar-um-unico-split-recebido", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/received/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-split-recebido", "operation": "Recuperar um único split recebido" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/accounts": { "get": { "tags": [ "Subcontas Asaas" ], "summary": "Listar subcontas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/accounts` capability.", "operationId": "listar-subcontas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts", "url": "https://docs.asaas.com/reference/listar-subcontas", "operation": "Listar subcontas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Subcontas Asaas" ], "summary": "Criar subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/accounts` capability.", "operationId": "criar-subconta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts", "url": "https://docs.asaas.com/reference/criar-subconta", "operation": "Criar subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/{id}": { "delete": { "tags": [ "Subcontas Asaas" ], "summary": "Encerrar subconta não-BaaS", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/accounts/{id}` capability.", "operationId": "encerrar-subconta-nao-baas", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/accounts/{id}", "url": "https://docs.asaas.com/reference/encerrar-subconta-nao-baas", "operation": "Encerrar subconta não-BaaS" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "get": { "tags": [ "Subcontas Asaas" ], "summary": "Recuperar uma única subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/accounts/{id}` capability.", "operationId": "recuperar-uma-unica-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-subconta", "operation": "Recuperar uma única subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/accounts/{id}/accessTokens": { "get": { "tags": [ "Subcontas Asaas" ], "summary": "Listar chaves de API de uma subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/accounts/{id}/accessTokens` capability.", "operationId": "listar-chaves-de-api-de-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/{id}/accessTokens", "url": "https://docs.asaas.com/reference/listar-chaves-de-api-de-uma-subconta", "operation": "Listar chaves de API de uma subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Subcontas Asaas" ], "summary": "Criar chave de API para uma subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/accounts/{id}/accessTokens` capability.", "operationId": "criar-chave-de-api-para-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/{id}/accessTokens", "url": "https://docs.asaas.com/reference/criar-chave-de-api-para-uma-subconta", "operation": "Criar chave de API para uma subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/{id}/accessTokens/{accessTokenId}": { "delete": { "tags": [ "Subcontas Asaas" ], "summary": "Excluir chave de API de uma subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/accounts/{id}/accessTokens/{accessTokenId}` capability.", "operationId": "excluir-chave-de-api-de-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "accessTokenId", "in": "path", "required": true, "description": "accessTokenId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/accounts/{id}/accessTokens/{accessTokenId}", "url": "https://docs.asaas.com/reference/excluir-chave-de-api-de-uma-subconta", "operation": "Excluir chave de API de uma subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Subcontas Asaas" ], "summary": "Atualizar chave de API de uma subconta", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/accounts/{id}/accessTokens/{accessTokenId}` capability.", "operationId": "atualizar-chave-de-api-de-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "accessTokenId", "in": "path", "required": true, "description": "accessTokenId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "PUT", "path": "/v3/accounts/{id}/accessTokens/{accessTokenId}", "url": "https://docs.asaas.com/reference/atualizar-chave-de-api-de-uma-subconta", "operation": "Atualizar chave de API de uma subconta" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/{id}/resendActivationLink": { "post": { "tags": [ "Subcontas Asaas" ], "summary": "Reenviar link de ativação para subconta não-BaaS", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/accounts/{id}/resendActivationLink` capability.", "operationId": "reenviar-link-de-ativacao-para-subconta-nao-baas", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/{id}/resendActivationLink", "url": "https://docs.asaas.com/reference/reenviar-link-de-ativacao-para-subconta-nao-baas", "operation": "Reenviar link de ativação para subconta não-BaaS" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/qrCodes/decode": { "post": { "tags": [ "Transações Pix" ], "summary": "Decodificar um QRCode para pagamento", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/qrCodes/decode` capability.", "operationId": "decodificar-um-qrcode-para-pagamento", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/qrCodes/decode", "url": "https://docs.asaas.com/reference/decodificar-um-qrcode-para-pagamento", "operation": "Decodificar um QRCode para pagamento" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/qrCodes/pay": { "post": { "tags": [ "Transações Pix" ], "summary": "Pagar um QRCode", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/qrCodes/pay` capability.", "operationId": "pagar-um-qrcode", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/qrCodes/pay", "url": "https://docs.asaas.com/reference/pagar-um-qrcode", "operation": "Pagar um QRCode" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/transactions": { "get": { "tags": [ "Transações Pix" ], "summary": "Listar transações", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/transactions` capability.", "operationId": "listar-transacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions", "url": "https://docs.asaas.com/reference/listar-transacoes", "operation": "Listar transações" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/transactions/{id}": { "get": { "tags": [ "Transações Pix" ], "summary": "Recuperar uma única transação", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/pix/transactions/{id}` capability.", "operationId": "recuperar-uma-unica-transacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-transacao", "operation": "Recuperar uma única transação" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/pix/transactions/{id}/cancel": { "post": { "tags": [ "Transações Pix" ], "summary": "Cancelar uma transação agendada", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/pix/transactions/{id}/cancel` capability.", "operationId": "cancelar-uma-transacao-agendada", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/transactions/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-transacao-agendada", "operation": "Cancelar uma transação agendada" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/transfers": { "get": { "tags": [ "Transferências" ], "summary": "Listar transferências", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/transfers` capability.", "operationId": "listar-transferencias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/transfers", "url": "https://docs.asaas.com/reference/listar-transferencias", "operation": "Listar transferências" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Transferências" ], "summary": "Transferir para conta de outra Instituição ou chave Pix", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/transfers` capability.\n\nAlso covers the Asaas parity operation **Transferir para conta Asaas**.", "operationId": "transferir-para-conta-de-outra-instituicao-ou-chave-pix", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "POST", "path": "/v3/transfers", "url": "https://docs.asaas.com/reference/transferir-para-conta-de-outra-instituicao-ou-chave-pix", "operation": "Transferir para conta de outra Instituição ou chave Pix" }, { "method": "POST", "path": "/v3/transfers/", "url": "https://docs.asaas.com/reference/transferir-para-conta-asaas", "operation": "Transferir para conta Asaas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/transfers/{id}": { "get": { "tags": [ "Transferências" ], "summary": "Recuperar uma única transferência", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/transfers/{id}` capability.", "operationId": "recuperar-uma-unica-transferencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.read", "x-asaas-source": [ { "method": "GET", "path": "/v3/transfers/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-transferencia", "operation": "Recuperar uma única transferência" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/transfers/{id}/cancel": { "delete": { "tags": [ "Transferências" ], "summary": "Cancelar uma transferência", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/transfers/{id}/cancel` capability.", "operationId": "cancelar-uma-transferência", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "passthrough", "x-duckledger-surface": "public", "x-duckledger-permission": "gateway_accounts.manage", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/transfers/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-transferência", "operation": "Cancelar uma transferência" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/ai-costs/catalog": { "get": { "tags": [ "ai-costs" ], "summary": "Catalog", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-aicosts-catalog", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AiCostsController.catalog", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/ai-costs/connections": { "get": { "tags": [ "ai-costs" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-list", "parameters": [ { "name": "includeOrganizationWide", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.list", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.read" ] }, "post": { "tags": [ "ai-costs" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.create", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/ai-costs/connections/{id}": { "delete": { "tags": [ "ai-costs" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.remove", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] } }, "/api/v1/ai-costs/connections/{id}/scopes": { "get": { "tags": [ "ai-costs" ], "summary": "List scopes", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-listscopes", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.listScopes", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.read" ] }, "put": { "tags": [ "ai-costs" ], "summary": "Update scopes", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-updatescopes", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.updateScopes", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/ai-costs/connections/{id}/scopes/refresh": { "post": { "tags": [ "ai-costs" ], "summary": "Refresh scopes", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-refreshscopes", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.refreshScopes", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] } }, "/api/v1/ai-costs/connections/{id}/sync": { "post": { "tags": [ "ai-costs" ], "summary": "Sync", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-sync", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.sync", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage" ] } }, "/api/v1/ai-costs/connections/{id}/test": { "post": { "tags": [ "ai-costs" ], "summary": "Test", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-test", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.test", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] } }, "/api/v1/ai-costs/dashboard": { "get": { "tags": [ "ai-costs" ], "summary": "Dashboard", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-aicosts-dashboard", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AiCostsController.dashboard", "x-duckledger-source": "apps/api/src/modules/ai-costs/ai-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "costs.read" ] } }, "/api/v1/api-keys": { "get": { "tags": [ "api-keys" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-apikeys-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ApiKeysController.list", "x-duckledger-source": "apps/api/src/modules/api-keys/api-keys.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "api_keys.read" ] }, "post": { "tags": [ "api-keys" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-apikeys-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ApiKeysController.create", "x-duckledger-source": "apps/api/src/modules/api-keys/api-keys.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "api_keys.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/api-keys/{id}": { "get": { "tags": [ "api-keys" ], "summary": "Get", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-apikeys-get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ApiKeysController.get", "x-duckledger-source": "apps/api/src/modules/api-keys/api-keys.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "api_keys.read" ] } }, "/api/v1/api-keys/{id}/permissions": { "patch": { "tags": [ "api-keys" ], "summary": "Update permissions", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-apikeys-updatepermissions", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ApiKeysController.updatePermissions", "x-duckledger-source": "apps/api/src/modules/api-keys/api-keys.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "api_keys.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/api-keys/{id}/revoke": { "post": { "tags": [ "api-keys" ], "summary": "Revoke", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-apikeys-revoke", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ApiKeysController.revoke", "x-duckledger-source": "apps/api/src/modules/api-keys/api-keys.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "api_keys.manage" ] } }, "/api/v1/audit-logs": { "get": { "tags": [ "audit" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-audit-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AuditController.list", "x-duckledger-source": "apps/api/src/modules/audit/audit.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "audit_logs.read" ] } }, "/api/v1/auth/forgot-password": { "post": { "tags": [ "auth" ], "summary": "Forgot password", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-forgotpassword", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.forgotPassword", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "202": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/auth/google": { "post": { "tags": [ "auth" ], "summary": "Google login", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-googlelogin", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.googleLogin", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/auth/login": { "post": { "tags": [ "auth" ], "summary": "Login", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-login", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.login", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/auth/logout": { "post": { "tags": [ "auth" ], "summary": "Logout", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-logout", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.logout", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/auth/logout-all": { "post": { "tags": [ "auth" ], "summary": "Logout all", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-auth-logoutall", "parameters": [], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AuthController.logoutAll", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/auth/me": { "get": { "tags": [ "auth" ], "summary": "Me", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-auth-me", "parameters": [], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AuthController.me", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/auth/refresh": { "post": { "tags": [ "auth" ], "summary": "Refresh", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-refresh", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.refresh", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/auth/register": { "post": { "tags": [ "auth" ], "summary": "Register", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-register", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.register", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/auth/resend-verification": { "post": { "tags": [ "auth" ], "summary": "Resend verification", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-resendverification", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.resendVerification", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "202": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/auth/reset-password": { "post": { "tags": [ "auth" ], "summary": "Reset password", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-resetpassword", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.resetPassword", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/auth/verify-email": { "post": { "tags": [ "auth" ], "summary": "Verify email", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-auth-verifyemail", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "AuthController.verifyEmail", "x-duckledger-source": "apps/api/src/modules/auth/auth.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/aws-connections": { "get": { "tags": [ "aws-connections" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-awsintegrations-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AwsIntegrationsController.list", "x-duckledger-source": "apps/api/src/modules/aws-integrations/aws-integrations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.read" ] }, "post": { "tags": [ "aws-connections" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-awsintegrations-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AwsIntegrationsController.create", "x-duckledger-source": "apps/api/src/modules/aws-integrations/aws-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/aws-connections/{id}": { "delete": { "tags": [ "aws-connections" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-awsintegrations-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AwsIntegrationsController.remove", "x-duckledger-source": "apps/api/src/modules/aws-integrations/aws-integrations.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] }, "patch": { "tags": [ "aws-connections" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-awsintegrations-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AwsIntegrationsController.update", "x-duckledger-source": "apps/api/src/modules/aws-integrations/aws-integrations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/aws-connections/{id}/dashboard": { "get": { "tags": [ "aws-connections" ], "summary": "Dashboard", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-awsintegrations-dashboard", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AwsIntegrationsController.dashboard", "x-duckledger-source": "apps/api/src/modules/aws-integrations/aws-integrations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "costs.read" ] } }, "/api/v1/aws-connections/{id}/sync": { "post": { "tags": [ "aws-connections" ], "summary": "Sync", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-awsintegrations-sync", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AwsIntegrationsController.sync", "x-duckledger-source": "apps/api/src/modules/aws-integrations/aws-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage" ] } }, "/api/v1/aws-connections/{id}/test": { "post": { "tags": [ "aws-connections" ], "summary": "Test", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-awsintegrations-test", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "AwsIntegrationsController.test", "x-duckledger-source": "apps/api/src/modules/aws-integrations/aws-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] } }, "/api/v1/checkout-sessions": { "get": { "tags": [ "checkout-sessions" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-checkoutsessions-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CheckoutSessionsController.list", "x-duckledger-source": "apps/api/src/modules/checkout-sessions/checkout-sessions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] }, "post": { "tags": [ "checkout-sessions" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-checkoutsessions-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CheckoutSessionsController.create", "x-duckledger-source": "apps/api/src/modules/checkout-sessions/checkout-sessions.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/checkout-sessions/{id}": { "get": { "tags": [ "checkout-sessions" ], "summary": "Get by id", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-checkoutsessions-getbyid", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CheckoutSessionsController.getById", "x-duckledger-source": "apps/api/src/modules/checkout-sessions/checkout-sessions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/checkout-sessions/by-reference/{externalReference}": { "get": { "tags": [ "checkout-sessions" ], "summary": "Get by reference", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-checkoutsessions-getbyreference", "parameters": [ { "name": "externalReference", "in": "path", "required": true, "description": "externalReference resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CheckoutSessionsController.getByReference", "x-duckledger-source": "apps/api/src/modules/checkout-sessions/checkout-sessions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/connected-accounts": { "get": { "tags": [ "connected-accounts" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-list", "parameters": [ { "name": "externalReference", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.list", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] }, "post": { "tags": [ "connected-accounts" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.create", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/connected-accounts/{id}": { "get": { "tags": [ "connected-accounts" ], "summary": "Get", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.get", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/connected-accounts/{id}/fiscal-info": { "get": { "tags": [ "connected-accounts" ], "summary": "Fiscal info", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-fiscalinfo", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.fiscalInfo", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] }, "post": { "tags": [ "connected-accounts" ], "summary": "Save fiscal info", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-savefiscalinfo", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.saveFiscalInfo", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/connected-accounts/{id}/fiscal-info/municipal-options": { "get": { "tags": [ "connected-accounts" ], "summary": "Municipal options", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-municipaloptions", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.municipalOptions", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/connected-accounts/{id}/fiscal-info/services": { "get": { "tags": [ "connected-accounts" ], "summary": "Municipal services", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-municipalservices", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.municipalServices", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/connected-accounts/{id}/invoices": { "get": { "tags": [ "connected-accounts" ], "summary": "List invoices", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-listinvoices", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.listInvoices", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] }, "post": { "tags": [ "connected-accounts" ], "summary": "Create invoice", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-createinvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.createInvoice", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/connected-accounts/{id}/invoices/{invoiceId}": { "get": { "tags": [ "connected-accounts" ], "summary": "Get invoice", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-getinvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "description": "invoiceId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.getInvoice", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/connected-accounts/{id}/invoices/{invoiceId}/authorize": { "post": { "tags": [ "connected-accounts" ], "summary": "Authorize invoice", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-authorizeinvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "description": "invoiceId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.authorizeInvoice", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ] } }, "/api/v1/connected-accounts/{id}/invoices/{invoiceId}/cancel": { "post": { "tags": [ "connected-accounts" ], "summary": "Cancel invoice", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-cancelinvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "description": "invoiceId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.cancelInvoice", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ] } }, "/api/v1/connected-accounts/{id}/onboarding": { "get": { "tags": [ "connected-accounts" ], "summary": "Onboarding", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-onboarding", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.onboarding", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/connected-accounts/{id}/sandbox/approve": { "post": { "tags": [ "connected-accounts" ], "summary": "Approve in sandbox", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-approveinsandbox", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.approveInSandbox", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ] } }, "/api/v1/connected-accounts/{id}/webhook": { "post": { "tags": [ "connected-accounts" ], "summary": "Reconfigure webhook", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-connectedaccounts-reconfigurewebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConnectedAccountsController.reconfigureWebhook", "x-duckledger-source": "apps/api/src/modules/connected-accounts/connected-accounts.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ] } }, "/api/v1/conversions/cohorts": { "get": { "tags": [ "conversions" ], "summary": "Cohorts", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-conversions-cohorts", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "entry", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConversionsController.cohorts", "x-duckledger-source": "apps/api/src/modules/conversions/conversions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/conversions/funnel": { "get": { "tags": [ "conversions" ], "summary": "Funnel", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-conversions-funnel", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConversionsController.funnel", "x-duckledger-source": "apps/api/src/modules/conversions/conversions.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/conversions/reconcile": { "post": { "tags": [ "conversions" ], "summary": "Reconcile", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-conversions-reconcile", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ConversionsController.reconcile", "x-duckledger-source": "apps/api/src/modules/conversions/conversions.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/cost-categories": { "get": { "tags": [ "cost-categories" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-costcategories-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CostCategoriesController.list", "x-duckledger-source": "apps/api/src/modules/cost-categories/cost-categories.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "costs.read" ] }, "post": { "tags": [ "cost-categories" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-costcategories-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CostCategoriesController.create", "x-duckledger-source": "apps/api/src/modules/cost-categories/cost-categories.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "costs.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/cost-categories/{id}/classification": { "patch": { "tags": [ "cost-categories" ], "summary": "Classify", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-costcategories-classify", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CostCategoriesController.classify", "x-duckledger-source": "apps/api/src/modules/cost-categories/cost-categories.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "costs.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/customer-metrics/cohorts": { "get": { "tags": [ "customer-metrics" ], "summary": "Cohorts", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-customermetrics-cohorts", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "basis", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CustomerMetricsController.cohorts", "x-duckledger-source": "apps/api/src/modules/customer-metrics/customer-metrics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/customer-metrics/customers/{customerId}/timeline": { "get": { "tags": [ "customer-metrics" ], "summary": "Timeline", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-customermetrics-timeline", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "customerId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CustomerMetricsController.timeline", "x-duckledger-source": "apps/api/src/modules/customer-metrics/customer-metrics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/customer-metrics/overview": { "get": { "tags": [ "customer-metrics" ], "summary": "Overview", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-customermetrics-overview", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CustomerMetricsController.overview", "x-duckledger-source": "apps/api/src/modules/customer-metrics/customer-metrics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/customer-metrics/retention-curve": { "get": { "tags": [ "customer-metrics" ], "summary": "Retention curve", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-customermetrics-retentioncurve", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "basis", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CustomerMetricsController.retentionCurve", "x-duckledger-source": "apps/api/src/modules/customer-metrics/customer-metrics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/customers/{customerId}/attributes": { "get": { "tags": [ "customer-attributes" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-customerattributes-list", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "customerId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CustomerAttributesController.list", "x-duckledger-source": "apps/api/src/modules/segments/segments.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] }, "put": { "tags": [ "customer-attributes" ], "summary": "Set", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-customerattributes-set", "parameters": [ { "name": "customerId", "in": "path", "required": true, "description": "customerId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "CustomerAttributesController.set", "x-duckledger-source": "apps/api/src/modules/segments/segments.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/dashboard/founder": { "get": { "tags": [ "dashboard" ], "summary": "Founder", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-dashboard-founder", "parameters": [ { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DashboardController.founder", "x-duckledger-source": "apps/api/src/modules/dashboard/dashboard.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/data-sources": { "get": { "tags": [ "data-sources" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-datasources-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataSourcesController.list", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.read" ] }, "post": { "tags": [ "data-sources" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-datasources-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataSourcesController.create", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/data-sources/{id}": { "delete": { "tags": [ "data-sources" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-datasources-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataSourcesController.remove", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] } }, "/api/v1/data-sources/{id}/sync": { "post": { "tags": [ "data-sources" ], "summary": "Sync", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-datasources-sync", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataSourcesController.sync", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage" ] } }, "/api/v1/data-sources/{id}/tables": { "get": { "tags": [ "data-sources" ], "summary": "Tables", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-datasources-tables", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataSourcesController.tables", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.read" ] } }, "/api/v1/data-sources/{id}/test": { "post": { "tags": [ "data-sources" ], "summary": "Test", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-datasources-test", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataSourcesController.test", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] } }, "/api/v1/data/exports/{dataset}": { "get": { "tags": [ "data-io" ], "summary": "Export csv", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-dataio-exportcsv", "parameters": [ { "name": "dataset", "in": "path", "required": true, "description": "dataset resource identifier.", "schema": { "type": "string" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataIoController.exportCsv", "x-duckledger-source": "apps/api/src/modules/data-io/data-io.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.export" ] } }, "/api/v1/data/imports": { "get": { "tags": [ "data-io" ], "summary": "List imports", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-dataio-listimports", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataIoController.listImports", "x-duckledger-source": "apps/api/src/modules/data-io/data-io.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] }, "post": { "tags": [ "data-io" ], "summary": "Import csv", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-dataio-importcsv", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataIoController.importCsv", "x-duckledger-source": "apps/api/src/modules/data-io/data-io.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions-any": [ "subscriptions.manage", "expenses.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/data/pricing/preview": { "post": { "tags": [ "data-io" ], "summary": "Preview pricing", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-dataio-previewpricing", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataIoController.previewPricing", "x-duckledger-source": "apps/api/src/modules/data-io/data-io.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/data/sources": { "get": { "tags": [ "data-io" ], "summary": "Catalog", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-dataio-catalog", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DataIoController.catalog", "x-duckledger-source": "apps/api/src/modules/data-io/data-io.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] } }, "/api/v1/duck-ai/chat": { "post": { "tags": [ "duck-ai" ], "summary": "Chat", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-duckai-chat", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "DuckAiController.chat", "x-duckledger-source": "apps/api/src/modules/duck-ai/duck-ai.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/entitlements": { "get": { "tags": [ "entitlements" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-entitlements-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "EntitlementsController.list", "x-duckledger-source": "apps/api/src/modules/entitlements/entitlements.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] }, "post": { "tags": [ "entitlements" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-entitlements-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "EntitlementsController.create", "x-duckledger-source": "apps/api/src/modules/entitlements/entitlements.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/entitlements/{code}": { "delete": { "tags": [ "entitlements" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-entitlements-remove", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "EntitlementsController.remove", "x-duckledger-source": "apps/api/src/modules/entitlements/entitlements.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/entitlements/{code}/products": { "post": { "tags": [ "entitlements" ], "summary": "Add product", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-entitlements-addproduct", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "EntitlementsController.addProduct", "x-duckledger-source": "apps/api/src/modules/entitlements/entitlements.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/entitlements/{code}/products/{productRowId}": { "delete": { "tags": [ "entitlements" ], "summary": "Remove product", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-entitlements-removeproduct", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "name": "productRowId", "in": "path", "required": true, "description": "productRowId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "EntitlementsController.removeProduct", "x-duckledger-source": "apps/api/src/modules/entitlements/entitlements.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/entitlements/unmapped-products": { "get": { "tags": [ "entitlements" ], "summary": "Unmapped", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-entitlements-unmapped", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "EntitlementsController.unmapped", "x-duckledger-source": "apps/api/src/modules/entitlements/entitlements.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] } }, "/api/v1/exchange-rates": { "get": { "tags": [ "exchange-rates" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-fx-list", "parameters": [ { "name": "base", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "quote", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "FxController.list", "x-duckledger-source": "apps/api/src/modules/fx/fx.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] }, "post": { "tags": [ "exchange-rates" ], "summary": "Upsert", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-fx-upsert", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "FxController.upsert", "x-duckledger-source": "apps/api/src/modules/fx/fx.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/exchange-rates/in-use": { "get": { "tags": [ "exchange-rates" ], "summary": "In use", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-fx-inuse", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "FxController.inUse", "x-duckledger-source": "apps/api/src/modules/fx/fx.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/expenses": { "get": { "tags": [ "expenses" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.list", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "expenses.read" ] }, "post": { "tags": [ "expenses" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.create", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "expenses.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/expenses/{id}": { "delete": { "tags": [ "expenses" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.remove", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "expenses.manage" ] }, "get": { "tags": [ "expenses" ], "summary": "Get by id", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-getbyid", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.getById", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "expenses.read" ] }, "patch": { "tags": [ "expenses" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.update", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "expenses.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/expenses/import": { "post": { "tags": [ "expenses" ], "summary": "Import csv", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-importcsv", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.importCsv", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "expenses.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/expenses/series": { "get": { "tags": [ "expenses" ], "summary": "Series", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-series", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.series", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "expenses.read" ] } }, "/api/v1/expenses/summary": { "get": { "tags": [ "expenses" ], "summary": "Summary", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-expenses-summary", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ExpensesController.summary", "x-duckledger-source": "apps/api/src/modules/expenses/expenses.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "costs.read" ] } }, "/api/v1/formulas": { "get": { "tags": [ "formulas" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-formulas-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "FormulasController.list", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.read" ] }, "post": { "tags": [ "formulas" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-formulas-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "FormulasController.create", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/formulas/{id}/evaluate": { "get": { "tags": [ "formulas" ], "summary": "Evaluate", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-formulas-evaluate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "FormulasController.evaluate", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.read" ] } }, "/api/v1/formulas/preview": { "post": { "tags": [ "formulas" ], "summary": "Preview", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-formulas-preview", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "FormulasController.preview", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.read" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/gateway-accounts": { "get": { "tags": [ "gateway-accounts" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.list", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.read" ] }, "post": { "tags": [ "gateway-accounts" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.create", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/gateway-accounts/{id}": { "delete": { "tags": [ "gateway-accounts" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.remove", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ] } }, "/api/v1/gateway-accounts/{id}/credentials": { "put": { "tags": [ "gateway-accounts" ], "summary": "Update credentials", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-updatecredentials", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.updateCredentials", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/gateway-accounts/{id}/financial-overview": { "get": { "tags": [ "gateway-accounts" ], "summary": "Financial overview", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-financialoverview", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "transactionOffset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "transactionLimit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.financialOverview", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.read" ] } }, "/api/v1/gateway-accounts/{id}/subscriptions/sync": { "post": { "tags": [ "gateway-accounts" ], "summary": "Sync subscriptions", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-subscriptionsync-syncsubscriptions", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SubscriptionSyncController.syncSubscriptions", "x-duckledger-source": "apps/api/src/modules/subscription-sync/subscription-sync.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/gateway-accounts/{id}/test": { "post": { "tags": [ "gateway-accounts" ], "summary": "Test", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-test", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.test", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ] } }, "/api/v1/gateway-accounts/{id}/webhook": { "post": { "tags": [ "gateway-accounts" ], "summary": "Reconfigure webhook", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-reconfigurewebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.reconfigureWebhook", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ] } }, "/api/v1/gateway-accounts/{id}/webhook-token": { "post": { "tags": [ "gateway-accounts" ], "summary": "Regenerate webhook token", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayaccounts-regeneratewebhooktoken", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayAccountsController.regenerateWebhookToken", "x-duckledger-source": "apps/api/src/modules/gateway/gateway.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ] } }, "/api/v1/gateway-api-logs": { "get": { "tags": [ "gateway-api-logs" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayapilogs-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayApiLogsController.list", "x-duckledger-source": "apps/api/src/modules/gateway/gateway-api-logs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.read" ] } }, "/api/v1/gateway-api-logs/{id}": { "get": { "tags": [ "gateway-api-logs" ], "summary": "Get", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayapilogs-get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayApiLogsController.get", "x-duckledger-source": "apps/api/src/modules/gateway/gateway-api-logs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.read" ] } }, "/api/v1/gateway-api-logs/summary": { "get": { "tags": [ "gateway-api-logs" ], "summary": "Summary", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-gatewayapilogs-summary", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "GatewayApiLogsController.summary", "x-duckledger-source": "apps/api/src/modules/gateway/gateway-api-logs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.read" ] } }, "/api/v1/margin/churn": { "get": { "tags": [ "margin" ], "summary": "Churn", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-margin-churn", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MarginController.churn", "x-duckledger-source": "apps/api/src/modules/margin/margin.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/margin/profit-cohorts": { "get": { "tags": [ "margin" ], "summary": "Profit cohorts", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-margin-profitcohorts", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MarginController.profitCohorts", "x-duckledger-source": "apps/api/src/modules/margin/margin.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/margin/unit-economics": { "get": { "tags": [ "margin" ], "summary": "Unit economics", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-margin-uniteconomics", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MarginController.unitEconomics", "x-duckledger-source": "apps/api/src/modules/margin/margin.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/metrics": { "get": { "tags": [ "metrics" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-metrics-list", "parameters": [ { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MetricsController.list", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.read" ] }, "post": { "tags": [ "metrics" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-metrics-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MetricsController.create", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/metrics/{id}": { "get": { "tags": [ "metrics" ], "summary": "Get by id", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-metrics-getbyid", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MetricsController.getById", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.read" ] }, "patch": { "tags": [ "metrics" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-metrics-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MetricsController.update", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/metrics/{id}/values": { "get": { "tags": [ "metrics" ], "summary": "Values", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-metrics-values", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MetricsController.values", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metric_values.read" ] }, "post": { "tags": [ "metrics" ], "summary": "Upsert value", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-metrics-upsertvalue", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MetricsController.upsertValue", "x-duckledger-source": "apps/api/src/modules/metrics/metrics.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "metrics.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/mrr-movements/backfill": { "post": { "tags": [ "mrr-movements" ], "summary": "Backfill", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-movements-backfill", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MovementsController.backfill", "x-duckledger-source": "apps/api/src/modules/revenue-movements/movements.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/mrr-movements/detect": { "post": { "tags": [ "mrr-movements" ], "summary": "Detect", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-movements-detect", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MovementsController.detect", "x-duckledger-source": "apps/api/src/modules/revenue-movements/movements.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/mrr-movements/waterfall": { "get": { "tags": [ "mrr-movements" ], "summary": "Waterfall", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-movements-waterfall", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "segment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "MovementsController.waterfall", "x-duckledger-source": "apps/api/src/modules/revenue-movements/movements.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/notifications/alerts": { "get": { "tags": [ "notifications" ], "summary": "Alerts", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-alerts", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.alerts", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.read" ] }, "post": { "tags": [ "notifications" ], "summary": "Create alert", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-createalert", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.createAlert", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/notifications/alerts/{code}": { "delete": { "tags": [ "notifications" ], "summary": "Remove alert", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-removealert", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.removeAlert", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ] } }, "/api/v1/notifications/alerts/evaluate": { "post": { "tags": [ "notifications" ], "summary": "Evaluate", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-evaluate", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.evaluate", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.read" ] } }, "/api/v1/notifications/channels": { "get": { "tags": [ "notifications" ], "summary": "Channels", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-channels", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.channels", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.read" ] }, "post": { "tags": [ "notifications" ], "summary": "Create channel", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-createchannel", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.createChannel", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/notifications/channels/{id}": { "delete": { "tags": [ "notifications" ], "summary": "Remove channel", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-removechannel", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.removeChannel", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ] } }, "/api/v1/notifications/deliveries": { "get": { "tags": [ "notifications" ], "summary": "Deliveries", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-deliveries", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.deliveries", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.read" ] } }, "/api/v1/notifications/reports": { "get": { "tags": [ "notifications" ], "summary": "Reports", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-reports", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.reports", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.read" ] }, "post": { "tags": [ "notifications" ], "summary": "Create report", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-createreport", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.createReport", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/notifications/reports/{code}": { "delete": { "tags": [ "notifications" ], "summary": "Remove report", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-removereport", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.removeReport", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ] } }, "/api/v1/notifications/reports/{code}/send": { "post": { "tags": [ "notifications" ], "summary": "Send report", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-sendreport", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.sendReport", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.read" ] } }, "/api/v1/notifications/shared-links": { "get": { "tags": [ "notifications" ], "summary": "Links", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-links", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.links", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.read" ] }, "post": { "tags": [ "notifications" ], "summary": "Create link", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-createlink", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.createLink", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/notifications/shared-links/{id}": { "delete": { "tags": [ "notifications" ], "summary": "Revoke link", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-notifications-revokelink", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "NotificationsController.revokeLink", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "reports.export" ] } }, "/api/v1/organizations": { "get": { "tags": [ "organizations" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-organizations-list", "parameters": [], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "OrganizationsController.list", "x-duckledger-source": "apps/api/src/modules/organizations/organizations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "organizations" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-organizations-create", "parameters": [], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "OrganizationsController.create", "x-duckledger-source": "apps/api/src/modules/organizations/organizations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/organizations/{id}": { "get": { "tags": [ "organizations" ], "summary": "Get by id", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-organizations-getbyid", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "OrganizationsController.getById", "x-duckledger-source": "apps/api/src/modules/organizations/organizations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.read" ] }, "patch": { "tags": [ "organizations" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-organizations-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "OrganizationsController.update", "x-duckledger-source": "apps/api/src/modules/organizations/organizations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/organizations/{organizationId}/invitations": { "post": { "tags": [ "organizations" ], "summary": "Invite", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-organizations-invite", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "organizationId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "OrganizationsController.invite", "x-duckledger-source": "apps/api/src/modules/organizations/organizations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "members.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/organizations/{organizationId}/members": { "get": { "tags": [ "organizations" ], "summary": "List members", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-organizations-listmembers", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "organizationId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "OrganizationsController.listMembers", "x-duckledger-source": "apps/api/src/modules/organizations/organizations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "members.read" ] } }, "/api/v1/organizations/{organizationId}/members/{memberId}": { "patch": { "tags": [ "organizations" ], "summary": "Update member", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-organizations-updatemember", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "organizationId resource identifier.", "schema": { "type": "string" } }, { "name": "memberId", "in": "path", "required": true, "description": "memberId resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "OrganizationsController.updateMember", "x-duckledger-source": "apps/api/src/modules/organizations/organizations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "members.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/payment-methods": { "get": { "tags": [ "payment-methods" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-paymentmethods-list", "parameters": [ { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PaymentMethodsController.list", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/payment-methods/{id}": { "delete": { "tags": [ "payment-methods" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-paymentmethods-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PaymentMethodsController.remove", "x-duckledger-source": "apps/api/src/modules/payments/payments.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ] } }, "/api/v1/plans": { "get": { "tags": [ "plans" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-plans-list", "parameters": [ { "name": "active", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlansController.list", "x-duckledger-source": "apps/api/src/modules/plans/plans.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] }, "post": { "tags": [ "plans" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-plans-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlansController.create", "x-duckledger-source": "apps/api/src/modules/plans/plans.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/plans/{id}": { "get": { "tags": [ "plans" ], "summary": "Get by id", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-plans-getbyid", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlansController.getById", "x-duckledger-source": "apps/api/src/modules/plans/plans.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] }, "patch": { "tags": [ "plans" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-plans-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlansController.update", "x-duckledger-source": "apps/api/src/modules/plans/plans.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/plans/{id}/activate": { "post": { "tags": [ "plans" ], "summary": "Activate", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-plans-activate", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlansController.activate", "x-duckledger-source": "apps/api/src/modules/plans/plans.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/plans/{id}/archive": { "post": { "tags": [ "plans" ], "summary": "Archive", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-plans-archive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlansController.archive", "x-duckledger-source": "apps/api/src/modules/plans/plans.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/platform/admin/customers": { "get": { "tags": [ "platform-admin" ], "summary": "Customers", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformadmin-customers", "parameters": [], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformAdminController.customers", "x-duckledger-source": "apps/api/src/modules/platform-admin/platform-admin.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/platform/admin/organizations": { "get": { "tags": [ "platform-admin" ], "summary": "Organizations", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformadmin-organizations", "parameters": [], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformAdminController.organizations", "x-duckledger-source": "apps/api/src/modules/platform-admin/platform-admin.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/platform/admin/organizations/{id}/complimentary-plan": { "post": { "tags": [ "platform-admin" ], "summary": "Grant", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformadmin-grant", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformAdminController.grant", "x-duckledger-source": "apps/api/src/modules/platform-admin/platform-admin.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/platform/admin/organizations/{id}/complimentary-plan/revoke": { "post": { "tags": [ "platform-admin" ], "summary": "Revoke", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformadmin-revoke", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformAdminController.revoke", "x-duckledger-source": "apps/api/src/modules/platform-admin/platform-admin.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/platform/admin/organizations/{id}/traces": { "get": { "tags": [ "platform-admin" ], "summary": "Traces", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformadmin-traces", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "cookieAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformAdminController.traces", "x-duckledger-source": "apps/api/src/modules/platform-admin/platform-admin.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/platform/billing": { "get": { "tags": [ "platform-billing" ], "summary": "Status", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformbilling-status", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformBillingController.status", "x-duckledger-source": "apps/api/src/modules/platform-billing/platform-billing.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.read" ] } }, "/api/v1/platform/billing/cancel": { "post": { "tags": [ "platform-billing" ], "summary": "Cancel", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformbilling-cancel", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformBillingController.cancel", "x-duckledger-source": "apps/api/src/modules/platform-billing/platform-billing.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ] } }, "/api/v1/platform/billing/checkout": { "post": { "tags": [ "platform-billing" ], "summary": "Start checkout", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-platformbilling-startcheckout", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "PlatformBillingController.startCheckout", "x-duckledger-source": "apps/api/src/modules/platform-billing/platform-billing.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/platform/billing/plans": { "get": { "tags": [ "platform-billing" ], "summary": "Plans", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-platformbilling-plans", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PlatformBillingController.plans", "x-duckledger-source": "apps/api/src/modules/platform-billing/platform-billing.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/profitability/overview": { "get": { "tags": [ "profitability" ], "summary": "Overview", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-profitability-overview", "parameters": [ { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProfitabilityController.overview", "x-duckledger-source": "apps/api/src/modules/profitability/profitability.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/profitability/workspaces": { "get": { "tags": [ "profitability" ], "summary": "Workspaces", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-profitability-workspaces", "parameters": [ { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProfitabilityController.workspaces", "x-duckledger-source": "apps/api/src/modules/profitability/profitability.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/projection/forecast": { "get": { "tags": [ "projection" ], "summary": "Forecast", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-projection-forecast", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lookback", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "scenario", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProjectionController.forecast", "x-duckledger-source": "apps/api/src/modules/projection/projection.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/projection/goals": { "get": { "tags": [ "projection" ], "summary": "Goals", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-projection-goals", "parameters": [ { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProjectionController.goals", "x-duckledger-source": "apps/api/src/modules/projection/projection.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] }, "post": { "tags": [ "projection" ], "summary": "Set goal", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-projection-setgoal", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProjectionController.setGoal", "x-duckledger-source": "apps/api/src/modules/projection/projection.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/projection/goals/{metric}/{period}": { "delete": { "tags": [ "projection" ], "summary": "Remove goal", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-projection-removegoal", "parameters": [ { "name": "metric", "in": "path", "required": true, "description": "metric resource identifier.", "schema": { "type": "string" } }, { "name": "period", "in": "path", "required": true, "description": "period resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProjectionController.removeGoal", "x-duckledger-source": "apps/api/src/modules/projection/projection.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ] } }, "/api/v1/projection/scenarios": { "get": { "tags": [ "projection" ], "summary": "Scenarios", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-projection-scenarios", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProjectionController.scenarios", "x-duckledger-source": "apps/api/src/modules/projection/projection.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] }, "post": { "tags": [ "projection" ], "summary": "Create scenario", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-projection-createscenario", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProjectionController.createScenario", "x-duckledger-source": "apps/api/src/modules/projection/projection.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/projection/scenarios/{code}": { "delete": { "tags": [ "projection" ], "summary": "Remove scenario", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-projection-removescenario", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "ProjectionController.removeScenario", "x-duckledger-source": "apps/api/src/modules/projection/projection.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ] } }, "/api/v1/public/cancellation-survey/{token}": { "get": { "tags": [ "public-cancellation-survey" ], "summary": "Show", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-publiccancellationsurvey-show", "parameters": [ { "name": "token", "in": "path", "required": true, "description": "token resource identifier.", "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PublicCancellationSurveyController.show", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "public-cancellation-survey" ], "summary": "Submit", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-publiccancellationsurvey-submit", "parameters": [ { "name": "token", "in": "path", "required": true, "description": "token resource identifier.", "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PublicCancellationSurveyController.submit", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/public/dashboards/{token}": { "get": { "tags": [ "shared-dashboard" ], "summary": "Show", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-publicdashboard-show", "parameters": [ { "name": "token", "in": "path", "required": true, "description": "token resource identifier.", "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PublicDashboardController.show", "x-duckledger-source": "apps/api/src/modules/notifications/notifications.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/public/recovery/{token}": { "get": { "tags": [ "public-recovery" ], "summary": "Show", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-publicrecovery-show", "parameters": [ { "name": "token", "in": "path", "required": true, "description": "token resource identifier.", "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PublicRecoveryController.show", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/retention/cancellation/breakdown": { "get": { "tags": [ "retention" ], "summary": "Breakdown", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-breakdown", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.breakdown", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/retention/cancellation/reasons": { "get": { "tags": [ "retention" ], "summary": "Reasons", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-reasons", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.reasons", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] }, "post": { "tags": [ "retention" ], "summary": "Create reason", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-createreason", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.createReason", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/cancellation/responses": { "post": { "tags": [ "retention" ], "summary": "Capture", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-capture", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.capture", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/cancellation/scan": { "post": { "tags": [ "retention" ], "summary": "Cancellation scan", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-cancellationscan", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.cancellationScan", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/retention/cancellation/settings": { "get": { "tags": [ "retention" ], "summary": "Cancellation settings", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-cancellationsettings", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.cancellationSettings", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.read" ] }, "post": { "tags": [ "retention" ], "summary": "Save cancellation settings", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-savecancellationsettings", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.saveCancellationSettings", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/churn-risk": { "get": { "tags": [ "retention" ], "summary": "Churn risk", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-churnrisk", "parameters": [ { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.churnRisk", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/retention/deflection/metrics": { "get": { "tags": [ "retention" ], "summary": "Deflection metrics", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-deflectionmetrics", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.deflectionMetrics", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] } }, "/api/v1/retention/emails": { "get": { "tags": [ "retention" ], "summary": "Emails", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-emails", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.emails", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/retention/recovery/preview": { "get": { "tags": [ "retention" ], "summary": "Recovery preview", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-recoverypreview", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.recoveryPreview", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/retention/recovery/scan": { "post": { "tags": [ "retention" ], "summary": "Scan", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-scan", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.scan", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.create" ] } }, "/api/v1/retention/recovery/settings": { "get": { "tags": [ "retention" ], "summary": "Settings", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-settings", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.settings", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.read" ] }, "post": { "tags": [ "retention" ], "summary": "Save settings", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-savesettings", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.saveSettings", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/recovery/summary": { "get": { "tags": [ "retention" ], "summary": "Recovery summary", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-recoverysummary", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.recoverySummary", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/retention/recovery/template": { "get": { "tags": [ "retention" ], "summary": "Recovery template", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-recoverytemplate", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.recoveryTemplate", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.read" ] }, "post": { "tags": [ "retention" ], "summary": "Save recovery template", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-saverecoverytemplate", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.saveRecoveryTemplate", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "organizations.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/subscriptions/{id}/pause": { "post": { "tags": [ "retention" ], "summary": "Pause subscription", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-pausesubscription", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.pauseSubscription", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/subscriptions/{id}/retention-offer": { "post": { "tags": [ "retention" ], "summary": "Apply retention offer", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-applyretentionoffer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.applyRetentionOffer", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/winback/campaigns": { "get": { "tags": [ "retention" ], "summary": "Campaigns", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-campaigns", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.campaigns", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] }, "post": { "tags": [ "retention" ], "summary": "Create campaign", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-createcampaign", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.createCampaign", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/winback/campaigns/{code}": { "patch": { "tags": [ "retention" ], "summary": "Update campaign", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-updatecampaign", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.updateCampaign", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/retention/winback/campaigns/{code}/preview": { "get": { "tags": [ "retention" ], "summary": "Preview campaign", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-previewcampaign", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.previewCampaign", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] } }, "/api/v1/retention/winback/campaigns/{code}/run": { "post": { "tags": [ "retention" ], "summary": "Run campaign", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-retention-runcampaign", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RetentionController.runCampaign", "x-duckledger-source": "apps/api/src/modules/retention/retention.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/revenue-attribution/payments/{id}/assign": { "post": { "tags": [ "revenue-attribution" ], "summary": "Assign", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueattribution-assign", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAttributionController.assign", "x-duckledger-source": "apps/api/src/modules/revenue-attribution/revenue-attribution.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "revenue_attribution.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/revenue-attribution/reattribute": { "post": { "tags": [ "revenue-attribution" ], "summary": "Reattribute", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueattribution-reattribute", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAttributionController.reattribute", "x-duckledger-source": "apps/api/src/modules/revenue-attribution/revenue-attribution.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "revenue_attribution.manage" ] } }, "/api/v1/revenue-attribution/rules": { "get": { "tags": [ "revenue-attribution" ], "summary": "List rules", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueattribution-listrules", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAttributionController.listRules", "x-duckledger-source": "apps/api/src/modules/revenue-attribution/revenue-attribution.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "revenue_attribution.read" ] }, "post": { "tags": [ "revenue-attribution" ], "summary": "Create rule", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueattribution-createrule", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAttributionController.createRule", "x-duckledger-source": "apps/api/src/modules/revenue-attribution/revenue-attribution.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "revenue_attribution.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/revenue-attribution/rules/{id}": { "delete": { "tags": [ "revenue-attribution" ], "summary": "Remove rule", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueattribution-removerule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAttributionController.removeRule", "x-duckledger-source": "apps/api/src/modules/revenue-attribution/revenue-attribution.module.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "revenue_attribution.manage" ] }, "patch": { "tags": [ "revenue-attribution" ], "summary": "Update rule", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueattribution-updaterule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAttributionController.updateRule", "x-duckledger-source": "apps/api/src/modules/revenue-attribution/revenue-attribution.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "revenue_attribution.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/revenue-attribution/unattributed": { "get": { "tags": [ "revenue-attribution" ], "summary": "Unattributed", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueattribution-unattributed", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAttributionController.unattributed", "x-duckledger-source": "apps/api/src/modules/revenue-attribution/revenue-attribution.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "revenue_attribution.read" ] } }, "/api/v1/revenue-metrics/mrr": { "get": { "tags": [ "revenue-metrics" ], "summary": "Mrr", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenuemetrics-mrr", "parameters": [ { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "at", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueMetricsController.mrr", "x-duckledger-source": "apps/api/src/modules/revenue-metrics/revenue-metrics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/revenue-metrics/mrr/backfill": { "post": { "tags": [ "revenue-metrics" ], "summary": "Backfill", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenuemetrics-backfill", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueMetricsController.backfill", "x-duckledger-source": "apps/api/src/modules/revenue-metrics/revenue-metrics.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/revenue-metrics/mrr/history": { "get": { "tags": [ "revenue-metrics" ], "summary": "History", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenuemetrics-history", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueMetricsController.history", "x-duckledger-source": "apps/api/src/modules/revenue-metrics/revenue-metrics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/revenue-metrics/recognition": { "get": { "tags": [ "revenue-metrics" ], "summary": "Recognized", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenuemetrics-recognized", "parameters": [ { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueMetricsController.recognized", "x-duckledger-source": "apps/api/src/modules/revenue-metrics/revenue-metrics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/revenue/customers": { "get": { "tags": [ "revenue" ], "summary": "Customers", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueaggregation-customers", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAggregationController.customers", "x-duckledger-source": "apps/api/src/modules/revenue-aggregation/revenue-aggregation.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/revenue/subscriptions": { "get": { "tags": [ "revenue" ], "summary": "Subscriptions", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueaggregation-subscriptions", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAggregationController.subscriptions", "x-duckledger-source": "apps/api/src/modules/revenue-aggregation/revenue-aggregation.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] } }, "/api/v1/revenue/subscriptions/{id}/cancel": { "post": { "tags": [ "revenue" ], "summary": "Cancel subscription", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueaggregation-cancelsubscription", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAggregationController.cancelSubscription", "x-duckledger-source": "apps/api/src/modules/revenue-aggregation/revenue-aggregation.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/revenue/sync": { "post": { "tags": [ "revenue" ], "summary": "Sync", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueaggregation-sync", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAggregationController.sync", "x-duckledger-source": "apps/api/src/modules/revenue-aggregation/revenue-aggregation.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/revenue/transactions": { "get": { "tags": [ "revenue" ], "summary": "Transactions", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueaggregation-transactions", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAggregationController.transactions", "x-duckledger-source": "apps/api/src/modules/revenue-aggregation/revenue-aggregation.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.read" ] } }, "/api/v1/revenue/transactions/{id}/refund": { "post": { "tags": [ "revenue" ], "summary": "Refund transaction", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-revenueaggregation-refundtransaction", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "RevenueAggregationController.refundTransaction", "x-duckledger-source": "apps/api/src/modules/revenue-aggregation/revenue-aggregation.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "payments.refund" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/segments": { "get": { "tags": [ "segments" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-segments-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SegmentsController.list", "x-duckledger-source": "apps/api/src/modules/segments/segments.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] }, "post": { "tags": [ "segments" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-segments-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SegmentsController.create", "x-duckledger-source": "apps/api/src/modules/segments/segments.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/segments/{code}": { "delete": { "tags": [ "segments" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-segments-remove", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "code resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SegmentsController.remove", "x-duckledger-source": "apps/api/src/modules/segments/segments.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/segments/attribute-keys": { "get": { "tags": [ "segments" ], "summary": "Keys", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-segments-keys", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SegmentsController.keys", "x-duckledger-source": "apps/api/src/modules/segments/segments.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/sql-queries": { "get": { "tags": [ "sql-queries" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-sqlqueries-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SqlQueriesController.list", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "sql_queries.read" ] }, "post": { "tags": [ "sql-queries" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-sqlqueries-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SqlQueriesController.create", "x-duckledger-source": "apps/api/src/modules/data-sources/data-sources.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "sql_queries.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-access": { "get": { "tags": [ "store-access" ], "summary": "For app user", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeaccess-forappuser", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreAccessController.forAppUser", "x-duckledger-source": "apps/api/src/modules/store-access/store-access.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.read" ] } }, "/api/v1/store-analytics/breakdown": { "get": { "tags": [ "store-analytics" ], "summary": "Breakdown", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeanalytics-breakdown", "parameters": [ { "name": "dimension", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreAnalyticsController.breakdown", "x-duckledger-source": "apps/api/src/modules/store-analytics/store-analytics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/store-analytics/cancel-reasons": { "get": { "tags": [ "store-analytics" ], "summary": "Cancel reasons", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeanalytics-cancelreasons", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreAnalyticsController.cancelReasons", "x-duckledger-source": "apps/api/src/modules/store-analytics/store-analytics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/store-analytics/economics": { "get": { "tags": [ "store-analytics" ], "summary": "Economics", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeanalytics-economics", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreAnalyticsController.economics", "x-duckledger-source": "apps/api/src/modules/store-analytics/store-analytics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/store-analytics/realized-ltv": { "get": { "tags": [ "store-analytics" ], "summary": "Realized ltv", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeanalytics-realizedltv", "parameters": [ { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreAnalyticsController.realizedLtv", "x-duckledger-source": "apps/api/src/modules/store-analytics/store-analytics.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "profitability.read" ] } }, "/api/v1/store-connections": { "get": { "tags": [ "store-connections" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.list", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.read" ] }, "post": { "tags": [ "store-connections" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.create", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-connections/{id}": { "delete": { "tags": [ "store-connections" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.remove", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ] }, "patch": { "tags": [ "store-connections" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.update", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-connections/{id}/backfill": { "post": { "tags": [ "store-connections" ], "summary": "Backfill", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-backfill", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.backfill", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/store-connections/{id}/purchases": { "post": { "tags": [ "store-connections" ], "summary": "Ingest purchase", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-ingestpurchase", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.ingestPurchase", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-connections/{id}/subscriptions/import": { "post": { "tags": [ "store-connections" ], "summary": "Import subscription", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-importsubscription", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.importSubscription", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-connections/{id}/subscriptions/sync": { "post": { "tags": [ "store-connections" ], "summary": "Sync", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-sync", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.sync", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "subscriptions.manage" ] } }, "/api/v1/store-connections/{id}/test": { "post": { "tags": [ "store-connections" ], "summary": "Test", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-test", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.test", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ] } }, "/api/v1/store-connections/{id}/webhook-secret": { "post": { "tags": [ "store-connections" ], "summary": "Set webhook secret", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-storeintegrations-setwebhooksecret", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "StoreIntegrationsController.setWebhookSecret", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-integrations.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "gateway_accounts.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-webhooks/apple/{connectionId}": { "post": { "tags": [ "store-webhooks" ], "summary": "Apple", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-storewebhooks-apple", "parameters": [ { "name": "connectionId", "in": "path", "required": true, "description": "connectionId resource identifier.", "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "StoreWebhooksController.apple", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-webhooks.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-webhooks/google/{connectionId}": { "post": { "tags": [ "store-webhooks" ], "summary": "Google", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-storewebhooks-google", "parameters": [ { "name": "connectionId", "in": "path", "required": true, "description": "connectionId resource identifier.", "schema": { "type": "string" } }, { "name": "token", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "StoreWebhooksController.google", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-webhooks.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/store-webhooks/revenuecat/{connectionId}": { "post": { "tags": [ "store-webhooks" ], "summary": "Revenue cat", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-storewebhooks-revenuecat", "parameters": [ { "name": "connectionId", "in": "path", "required": true, "description": "connectionId resource identifier.", "schema": { "type": "string" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "StoreWebhooksController.revenueCat", "x-duckledger-source": "apps/api/src/modules/store-integrations/store-webhooks.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/suppliers": { "get": { "tags": [ "suppliers" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-suppliers-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SuppliersController.list", "x-duckledger-source": "apps/api/src/modules/suppliers/suppliers.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "suppliers.read" ] }, "post": { "tags": [ "suppliers" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-suppliers-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "SuppliersController.create", "x-duckledger-source": "apps/api/src/modules/suppliers/suppliers.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "suppliers.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/usage/apis": { "get": { "tags": [ "usage" ], "summary": "Api usage", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-apiusage", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.apiUsage", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/cost-reconciliation": { "get": { "tags": [ "usage" ], "summary": "Cost reconciliation", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-costreconciliation", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.costReconciliation", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/events/batch": { "post": { "tags": [ "usage" ], "summary": "Events", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-events", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.events", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage_events.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/usage/identify": { "post": { "tags": [ "usage" ], "summary": "Identify", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-identify", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.identify", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage_events.create" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/usage/ingest-keys": { "post": { "tags": [ "usage" ], "summary": "Create ingest key", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-createingestkey", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.createIngestKey", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/usage/live": { "get": { "tags": [ "usage" ], "summary": "Live", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-live", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.live", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/meters": { "get": { "tags": [ "usage" ], "summary": "Meters", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-meters", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.meters", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions-any": [ "usage.read", "usage_meters.read" ] }, "post": { "tags": [ "usage" ], "summary": "Create meter", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-createmeter", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.createMeter", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/usage/meters/ensure": { "post": { "tags": [ "usage" ], "summary": "Ensure meters", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-ensuremeters", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.ensureMeters", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions-any": [ "usage.manage", "usage_meters.provision" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/usage/rollups": { "get": { "tags": [ "usage" ], "summary": "Rollups", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-rollups", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.rollups", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/subjects": { "get": { "tags": [ "usage" ], "summary": "Subjects", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-subjects", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.subjects", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/subjects/{id}/link": { "post": { "tags": [ "usage" ], "summary": "Link subject", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-linksubject", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.linkSubject", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/usage/subjects/{id}/profile": { "get": { "tags": [ "usage" ], "summary": "Subject profile", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-subjectprofile", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.subjectProfile", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/subjects/activity": { "get": { "tags": [ "usage" ], "summary": "Subject activity", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-subjectactivity", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.subjectActivity", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/subjects/reconcile": { "post": { "tags": [ "usage" ], "summary": "Reconcile subjects", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-reconcilesubjects", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.reconcileSubjects", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.manage" ] } }, "/api/v1/usage/timeline": { "get": { "tags": [ "usage" ], "summary": "Timeline", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-timeline", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.timeline", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/traces": { "get": { "tags": [ "usage" ], "summary": "Traces", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-traces", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.traces", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/usage/traces/{id}": { "get": { "tags": [ "usage" ], "summary": "Trace", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-usage-trace", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "UsageController.trace", "x-duckledger-source": "apps/api/src/modules/usage/usage.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "usage.read" ] } }, "/api/v1/webhook-endpoints/{id}/rotate-secret": { "post": { "tags": [ "webhook-endpoints" ], "summary": "Rotate secret", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-webhookendpoints-rotatesecret", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WebhookEndpointsController.rotateSecret", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.manage" ] } }, "/api/v1/webhook-endpoints/{id}/test": { "post": { "tags": [ "webhook-endpoints" ], "summary": "Test", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-webhookendpoints-test", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WebhookEndpointsController.test", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.manage" ] } }, "/api/v1/webhook-endpoints/deliveries": { "get": { "tags": [ "webhook-endpoints" ], "summary": "Deliveries", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-webhookendpoints-deliveries", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WebhookEndpointsController.deliveries", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.read" ] } }, "/api/v1/webhook-endpoints/events": { "get": { "tags": [ "webhook-endpoints" ], "summary": "Available events", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-webhookendpoints-availableevents", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WebhookEndpointsController.availableEvents", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-endpoints.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.read" ] } }, "/api/v1/webhook-logs": { "get": { "tags": [ "webhook-logs" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-webhooklogs-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WebhookLogsController.list", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-logs.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.read" ] } }, "/api/v1/webhook-logs/{id}": { "get": { "tags": [ "webhook-logs" ], "summary": "Get", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-webhooklogs-get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WebhookLogsController.get", "x-duckledger-source": "apps/api/src/modules/webhooks/webhook-logs.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "webhooks.read" ] } }, "/api/v1/webhooks/abacatepay/{gatewayAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive abacate pay", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receiveabacatepay", "parameters": [ { "name": "gatewayAccountId", "in": "path", "required": true, "description": "gatewayAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "webhookSecret", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "x-webhook-signature", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receiveAbacatePay", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/asaas/{gatewayAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive asaas", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receiveasaas", "parameters": [ { "name": "gatewayAccountId", "in": "path", "required": true, "description": "gatewayAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "asaas-access-token", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receiveAsaas", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/asaas/connected/{connectedAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive asaas connected", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receiveasaasconnected", "parameters": [ { "name": "connectedAccountId", "in": "path", "required": true, "description": "connectedAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "asaas-access-token", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receiveAsaasConnected", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/iugu/{gatewayAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive iugu", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receiveiugu", "parameters": [ { "name": "gatewayAccountId", "in": "path", "required": true, "description": "gatewayAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "iugu-signature", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "authorization", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receiveIugu", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/mercadopago/{gatewayAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive mercado pago", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receivemercadopago", "parameters": [ { "name": "gatewayAccountId", "in": "path", "required": true, "description": "gatewayAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "x-signature", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receiveMercadoPago", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/paddle/{gatewayAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive paddle", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receivepaddle", "parameters": [ { "name": "gatewayAccountId", "in": "path", "required": true, "description": "gatewayAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "paddle-signature", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receivePaddle", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/pagarme/{gatewayAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive pagarme", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receivepagarme", "parameters": [ { "name": "gatewayAccountId", "in": "path", "required": true, "description": "gatewayAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "x-hub-signature", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "x-pagarme-signature", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receivePagarme", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/platform/asaas": { "post": { "tags": [ "platform-billing" ], "summary": "Receive asaas", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-platformbillingwebhook-receiveasaas", "parameters": [ { "name": "asaas-access-token", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PlatformBillingWebhookController.receiveAsaas", "x-duckledger-source": "apps/api/src/modules/platform-billing/platform-billing.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/platform/stripe": { "post": { "tags": [ "platform-billing" ], "summary": "Receive stripe", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-platformbillingwebhook-receivestripe", "parameters": [ { "name": "stripe-signature", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "PlatformBillingWebhookController.receiveStripe", "x-duckledger-source": "apps/api/src/modules/platform-billing/platform-billing.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/webhooks/stripe/{gatewayAccountId}": { "post": { "tags": [ "webhooks" ], "summary": "Receive stripe", "description": "Public DuckLedger platform endpoint.", "operationId": "duckledger-webhooks-receivestripe", "parameters": [ { "name": "gatewayAccountId", "in": "path", "required": true, "description": "gatewayAccountId resource identifier.", "schema": { "type": "string" } }, { "name": "stripe-signature", "in": "header", "required": false, "schema": { "type": "string" } } ], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "public", "x-duckledger-controller": "WebhooksController.receiveStripe", "x-duckledger-source": "apps/api/src/modules/gateway/webhooks.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/whatsapp-connections": { "get": { "tags": [ "whatsapp-connections" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-whatsappcosts-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WhatsappCostsController.list", "x-duckledger-source": "apps/api/src/modules/whatsapp-costs/whatsapp-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.read" ] }, "post": { "tags": [ "whatsapp-connections" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-whatsappcosts-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WhatsappCostsController.create", "x-duckledger-source": "apps/api/src/modules/whatsapp-costs/whatsapp-costs.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/whatsapp-connections/{id}": { "delete": { "tags": [ "whatsapp-connections" ], "summary": "Remove", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-whatsappcosts-remove", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WhatsappCostsController.remove", "x-duckledger-source": "apps/api/src/modules/whatsapp-costs/whatsapp-costs.controller.ts", "responses": { "204": { "description": "Operation completed successfully with no response body." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] }, "patch": { "tags": [ "whatsapp-connections" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-whatsappcosts-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WhatsappCostsController.update", "x-duckledger-source": "apps/api/src/modules/whatsapp-costs/whatsapp-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/whatsapp-connections/{id}/dashboard": { "get": { "tags": [ "whatsapp-connections" ], "summary": "Dashboard", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-whatsappcosts-dashboard", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "months", "in": "query", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WhatsappCostsController.dashboard", "x-duckledger-source": "apps/api/src/modules/whatsapp-costs/whatsapp-costs.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "costs.read" ] } }, "/api/v1/whatsapp-connections/{id}/sync": { "post": { "tags": [ "whatsapp-connections" ], "summary": "Sync", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-whatsappcosts-sync", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WhatsappCostsController.sync", "x-duckledger-source": "apps/api/src/modules/whatsapp-costs/whatsapp-costs.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage" ] } }, "/api/v1/whatsapp-connections/{id}/test": { "post": { "tags": [ "whatsapp-connections" ], "summary": "Test", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-whatsappcosts-test", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WhatsappCostsController.test", "x-duckledger-source": "apps/api/src/modules/whatsapp-costs/whatsapp-costs.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "data_sources.manage", "database_credentials.manage" ] } }, "/api/v1/workspaces": { "get": { "tags": [ "workspaces" ], "summary": "List", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-workspaces-list", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WorkspacesController.list", "x-duckledger-source": "apps/api/src/modules/workspaces/workspaces.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "workspaces.read" ] }, "post": { "tags": [ "workspaces" ], "summary": "Create", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-workspaces-create", "parameters": [ { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WorkspacesController.create", "x-duckledger-source": "apps/api/src/modules/workspaces/workspaces.controller.ts", "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "workspaces.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/api/v1/workspaces/{id}": { "get": { "tags": [ "workspaces" ], "summary": "Get by id", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-workspaces-getbyid", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WorkspacesController.getById", "x-duckledger-source": "apps/api/src/modules/workspaces/workspaces.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "workspaces.read" ] }, "patch": { "tags": [ "workspaces" ], "summary": "Update", "description": "Authenticated DuckLedger control-plane endpoint. This operation is callable but is not part of the Asaas parity surface.", "operationId": "duckledger-workspaces-update", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/OrganizationHeader" }, { "$ref": "#/components/parameters/WorkspaceHeader" } ], "security": [ { "cookieAuth": [] }, { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "internal", "x-duckledger-controller": "WorkspacesController.update", "x-duckledger-source": "apps/api/src/modules/workspaces/workspaces.controller.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "x-duckledger-permissions": [ "workspaces.manage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "Request body accepted by the DuckLedger controller." } } } } } }, "/health": { "get": { "tags": [ "health" ], "summary": "Health", "description": "Unauthenticated service health endpoint.", "operationId": "duckledger-health-health", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "health", "x-duckledger-controller": "HealthController.health_", "x-duckledger-source": "apps/api/src/modules/health/health.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/health/live": { "get": { "tags": [ "health" ], "summary": "Live", "description": "Unauthenticated service health endpoint.", "operationId": "duckledger-health-live", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "health", "x-duckledger-controller": "HealthController.live", "x-duckledger-source": "apps/api/src/modules/health/health.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/health/ready": { "get": { "tags": [ "health" ], "summary": "Ready", "description": "Unauthenticated service health endpoint.", "operationId": "duckledger-health-ready", "parameters": [], "security": [], "x-duckledger-status": "available", "x-duckledger-implementation": "native", "x-duckledger-surface": "health", "x-duckledger-controller": "HealthController.ready", "x-duckledger-source": "apps/api/src/modules/health/health.module.ts", "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Use `dlk_live_...` on api.duckledger.com or `dlk_test_...` on sandbox-api.duckledger.com." }, "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "dl_access", "description": "Authenticated DuckLedger browser session." } }, "parameters": { "OrganizationHeader": { "name": "x-organization-id", "in": "header", "required": false, "description": "Active organization UUID. Required for browser sessions and ignored for organization-bound API keys.", "schema": { "type": "string", "format": "uuid" } }, "WorkspaceHeader": { "name": "x-workspace-id", "in": "header", "required": false, "description": "Optional active workspace UUID within the selected organization.", "schema": { "type": "string", "format": "uuid" } } }, "schemas": { "SuccessEnvelope": { "type": "object", "properties": { "data": { "type": [ "object", "array", "null" ] }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } }, "ErrorEnvelope": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {}, "requestId": { "type": "string" } } } } } }, "responses": { "BadRequest": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "Unauthorized": { "description": "Authentication is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "Forbidden": { "description": "The authenticated caller does not have the required permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "NotFound": { "description": "The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "x-duckledger-parity-total": 213, "x-duckledger-native-total": 310, "x-duckledger-operation-total": 499, "x-duckledger-generated-at": "2026-10-07T20:00:56.895Z" }