@comando.one/mcp-server 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/index.js +658 -23
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -43,7 +43,7 @@ Além deste pacote stdio, existe um **endpoint MCP remoto (streaming)** em `http
|
|
|
43
43
|
}
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
Ambos expõem as mesmas ferramentas: **
|
|
46
|
+
Ambos expõem as mesmas ferramentas: **191 tools curadas** (uma por operação da API, em 17/11/2026) + `lookups` + `comando_request`. Só o stdio tem `whoami`.
|
|
47
47
|
|
|
48
48
|
## Variáveis de ambiente
|
|
49
49
|
|
|
@@ -55,7 +55,7 @@ Ambos expõem as mesmas ferramentas: **169 tools curadas** (uma por operação d
|
|
|
55
55
|
|
|
56
56
|
## Como funciona
|
|
57
57
|
|
|
58
|
-
- **
|
|
58
|
+
- **191 tools curadas** (geradas a partir do OpenAPI canônico, zero drift) — uma por operação da API, por exemplo `customers_list`, `invoices_create`/`invoices_delete`, `charges_create`, `nfse_emit`, `payouts_create`, `contracts_pause`/`contracts_resume`, `service_categories_create`, `reports_aging_actions`/`reports_cashflow_forecast`, `audit_timeline`, `documents_analyze` (lê boleto/guia/NF anexada e extrai valor, vencimento e emitente), `cost_centers_create`, `invoices_settle_charge` (dá baixa numa parcela — registra o recebimento), etc.
|
|
59
59
|
- **`comando_request`** — escape hatch genérico (`method`, `path`, `query`, `body`) para qualquer rota; as destrutivas continuam exigindo `confirm`.
|
|
60
60
|
- **`lookups`** — catálogos read-only (centros de custo, condições/métodos de pagamento, naturezas, contas bancárias).
|
|
61
61
|
- **`whoami`** — identidade, empresas acessíveis e scopes da chave.
|
package/dist/index.js
CHANGED
|
@@ -154,6 +154,7 @@ var MANIFEST = [
|
|
|
154
154
|
// ----- Cobranças -----
|
|
155
155
|
{ operationId: "listCharges", tool: "charges_list" },
|
|
156
156
|
{ operationId: "getCharge", tool: "charges_get" },
|
|
157
|
+
{ operationId: "getChargePdf", tool: "charges_pdf" },
|
|
157
158
|
{ operationId: "createCharge", tool: "charges_create", write: true },
|
|
158
159
|
{ operationId: "confirmCharge", tool: "charges_confirm", write: true },
|
|
159
160
|
{ operationId: "cancelCharge", tool: "charges_cancel", write: true, destructive: true },
|
|
@@ -181,6 +182,7 @@ var MANIFEST = [
|
|
|
181
182
|
{ operationId: "createPurchaseInvoice", tool: "purchase_invoices_create", write: true },
|
|
182
183
|
{ operationId: "cancelPurchaseInvoice", tool: "purchase_invoices_cancel", write: true, destructive: true },
|
|
183
184
|
{ operationId: "deletePurchaseInvoice", tool: "purchase_invoices_delete", write: true, destructive: true },
|
|
185
|
+
{ operationId: "payPurchaseInvoice", tool: "purchase_invoices_pay", write: true },
|
|
184
186
|
// ----- Despesas & Serviços -----
|
|
185
187
|
{ operationId: "listExpenses", tool: "expenses_list" },
|
|
186
188
|
{ operationId: "createExpense", tool: "expenses_create", write: true },
|
|
@@ -200,6 +202,27 @@ var MANIFEST = [
|
|
|
200
202
|
{ operationId: "getSplitExecution", tool: "split_executions_get" },
|
|
201
203
|
{ operationId: "reverseSplitExecution", tool: "split_reverse", write: true, destructive: true },
|
|
202
204
|
{ operationId: "releaseSplitItem", tool: "split_release_item", write: true },
|
|
205
|
+
// ----- Parcerias (caixa compartilhado com parceiro; specs/parcerias/) -----
|
|
206
|
+
{ operationId: "listParcerias", tool: "parcerias_list" },
|
|
207
|
+
{ operationId: "getParceria", tool: "parcerias_get" },
|
|
208
|
+
{ operationId: "createParceria", tool: "parcerias_create", write: true },
|
|
209
|
+
{ operationId: "updateParceria", tool: "parcerias_update", write: true },
|
|
210
|
+
{ operationId: "closeParceria", tool: "parcerias_close", write: true, destructive: true },
|
|
211
|
+
{ operationId: "listParceriaLancamentos", tool: "parcerias_lancamentos_list" },
|
|
212
|
+
{ operationId: "createParceriaLancamento", tool: "parcerias_lancar", write: true },
|
|
213
|
+
{ operationId: "reverseParceriaLancamento", tool: "parcerias_estornar", write: true, destructive: true },
|
|
214
|
+
{ operationId: "createParceriaRetirada", tool: "parcerias_retirar", write: true, destructive: true },
|
|
215
|
+
{ operationId: "resolveParceriaNota", tool: "parcerias_resolver_nota", write: true },
|
|
216
|
+
{ operationId: "listParceriaVinculos", tool: "parcerias_vinculos_list" },
|
|
217
|
+
{ operationId: "createParceriaVinculo", tool: "parcerias_vincular", write: true },
|
|
218
|
+
{ operationId: "deleteParceriaVinculo", tool: "parcerias_desvincular", write: true, destructive: true },
|
|
219
|
+
{ operationId: "updateParceriaVinculo", tool: "parcerias_vinculo_antecipar", write: true },
|
|
220
|
+
{ operationId: "previewParceriaVinculo", tool: "parcerias_vinculo_previa" },
|
|
221
|
+
{ operationId: "updateParceriaParticipantes", tool: "parcerias_participantes_update", write: true, destructive: true },
|
|
222
|
+
{ operationId: "updateParceriaSaldoInicial", tool: "parcerias_saldo_inicial_update", write: true },
|
|
223
|
+
{ operationId: "upsertParceriaEmpresa", tool: "parcerias_empresa_upsert", write: true },
|
|
224
|
+
{ operationId: "deleteParceriaEmpresa", tool: "parcerias_empresa_remover", write: true, destructive: true },
|
|
225
|
+
{ operationId: "getParceriaPrestacao", tool: "parcerias_prestacao_de_contas" },
|
|
203
226
|
// Auditoria
|
|
204
227
|
{ operationId: "analyzeDocument", tool: "documents_analyze", write: true },
|
|
205
228
|
{ operationId: "listDocuments", tool: "documents_search" },
|
|
@@ -384,7 +407,10 @@ var WEBHOOK_EVENT_KEYS = [
|
|
|
384
407
|
"repasse.failed",
|
|
385
408
|
"repasse.reversed",
|
|
386
409
|
"supplier_payout_request.created",
|
|
387
|
-
"supplier_payout_request.approved"
|
|
410
|
+
"supplier_payout_request.approved",
|
|
411
|
+
"plan.limit_near",
|
|
412
|
+
"parceria.entry_created",
|
|
413
|
+
"parceria.note_matched"
|
|
388
414
|
];
|
|
389
415
|
var SCHEMAS = {
|
|
390
416
|
Error: {
|
|
@@ -684,7 +710,7 @@ var SCHEMAS = {
|
|
|
684
710
|
invoice_number: { type: ["string", "null"] },
|
|
685
711
|
title: { type: ["string", "null"] },
|
|
686
712
|
amount: { type: "number" },
|
|
687
|
-
status: { type: "string", enum: ["rascunho", "enviada", "aceita", "cancelada"] },
|
|
713
|
+
status: { type: "string", enum: ["rascunho", "enviada", "aceita", "ativa", "cancelada"] },
|
|
688
714
|
payment_status: { type: "string", enum: ["pendente", "parcial", "pago", "vencido"] },
|
|
689
715
|
due_date: { type: ["string", "null"], format: "date" },
|
|
690
716
|
proposal_id: { type: ["string", "null"], format: "uuid" },
|
|
@@ -954,7 +980,7 @@ var SCHEMAS = {
|
|
|
954
980
|
required: ["name"],
|
|
955
981
|
properties: {
|
|
956
982
|
name: { type: "string", description: "Nome do item (exibi\xE7\xE3o). Na NFS-e s\xF3 \xE9 usado se `description` vier vazio." },
|
|
957
|
-
description: { type: "string", description:
|
|
983
|
+
description: { type: "string", description: 'Detalhe do item. Na discrimina\xE7\xE3o da NFS-e vai abaixo do `name`, inteiro se couber na DANFS-e; se n\xE3o couber, s\xF3 o que couber, com "\u2026 (+N linhas)".' },
|
|
958
984
|
unit: { type: "string", default: "un" },
|
|
959
985
|
quantity: { type: "number", default: 1 },
|
|
960
986
|
unit_price: { type: "number" },
|
|
@@ -985,8 +1011,8 @@ var SCHEMAS = {
|
|
|
985
1011
|
id: { type: "string", format: "uuid" },
|
|
986
1012
|
status: { type: "string", enum: ["pending", "paid", "cancelled", "expired", "failed"] },
|
|
987
1013
|
status_raw: { type: "string", description: "Status bruto do provider" },
|
|
988
|
-
method: { type: "string", enum: ["pix", "boleto", "checkout", "credit_card"] },
|
|
989
|
-
provider: { type: "string", enum: ["inter", "c6bank", "pix_offline", "pagarme", "cora"], description: "Provedor resolvido. 'pix_offline' = Pix est\xE1tico (BR Code local). 'pagarme' = Pix server-side ou cart\xE3o (method=credit_card retorna 'checkout.url' = link da p\xE1gina de pagamento). 'cora' = boleto ou Pix emitidos de forma s\xEDncrona (o boleto j\xE1 volta com 'pdf_url')." },
|
|
1014
|
+
method: { type: "string", enum: ["pix", "boleto", "checkout", "credit_card", "pix_automatico"], description: "Canal. 'pix_automatico' = cobran\xE7a do ciclo de uma recorr\xEAncia Pix Autom\xE1tico (Inter ou C6), criada pelo sistema \u2014 n\xE3o sai por POST /v1/charges." },
|
|
1015
|
+
provider: { type: "string", enum: ["inter", "c6bank", "pix_offline", "pagarme", "cora", "mercadopago"], description: "Provedor resolvido. 'pix_offline' = Pix est\xE1tico (BR Code local). 'pagarme' = Pix server-side ou cart\xE3o (method=credit_card retorna 'checkout.url' = link da p\xE1gina de pagamento). 'cora' = boleto ou Pix emitidos de forma s\xEDncrona (o boleto j\xE1 volta com 'pdf_url'). 'mercadopago' = cobran\xE7a feita pela tela/assinatura do Mercado Pago (s\xF3 leitura: POST /v1/charges n\xE3o emite por ele)." },
|
|
990
1016
|
invoice_id: { type: ["string", "null"], format: "uuid" },
|
|
991
1017
|
customer_id: { type: ["string", "null"], format: "uuid" },
|
|
992
1018
|
amount: { type: ["number", "null"] },
|
|
@@ -1008,8 +1034,12 @@ var SCHEMAS = {
|
|
|
1008
1034
|
charge_id: { type: "string", format: "uuid", description: "PARCELA da fatura a cobrar (invoice_charges.id \u2014 veja GET /v1/invoices/{id}/charges). S\xF3 vale com invoice_id. Quando informado, a cobran\xE7a sai com o VALOR e o VENCIMENTO da parcela e fica amarrada a ela, que \xE9 o que d\xE1 baixa certa quando o dinheiro entra. Omitido, a cobran\xE7a \xE9 no n\xEDvel da fatura (valor cheio) \u2014 numa fatura parcelada isso normalmente n\xE3o \xE9 o que se quer." },
|
|
1009
1035
|
customer_id: { type: "string", format: "uuid", description: "Obrigat\xF3rio se invoice_id omitido" },
|
|
1010
1036
|
amount: { type: "number", description: "Obrigat\xF3rio se invoice_id omitido" },
|
|
1011
|
-
due_date: { type: "string", format: "date", description: "Obrigat\xF3rio se invoice_id omitido" },
|
|
1012
|
-
description: { type: "string" }
|
|
1037
|
+
due_date: { type: "string", format: "date", description: "Obrigat\xF3rio se invoice_id omitido. Com invoice_id (+ charge_id), s\xF3 no Inter e no C6: vencimento do boleto NOVO, para cobrar parcela vencida sem alterar a fatura (n\xE3o pode estar no passado; se a parcela j\xE1 tem cobran\xE7a viva, 409 \u2014 cancele antes)." },
|
|
1038
|
+
description: { type: "string" },
|
|
1039
|
+
fine: { type: "object", description: "Boleto Inter ou C6: multa por atraso. Sem ele vale a configura\xE7\xE3o da empresa; value 0 desliga a da empresa nesta cobran\xE7a.", properties: { type: { type: "string", enum: ["percent", "amount"] }, value: { type: "number" } } },
|
|
1040
|
+
interest: { type: "object", description: "Boleto Inter ou C6: juros de mora (value 0 desliga). Use monthly_percent (% ao m\xEAs) OU daily_amount (R$/dia).", properties: { monthly_percent: { type: "number" }, daily_amount: { type: "number" } } },
|
|
1041
|
+
discount: { type: "object", description: "Boleto Inter ou C6: desconto por antecipa\xE7\xE3o (value 0 desliga).", properties: { type: { type: "string", enum: ["percent", "amount"] }, value: { type: "number" }, days_before: { type: "integer" } } },
|
|
1042
|
+
messages: { type: "array", maxItems: 5, items: { type: "string" }, description: "S\xF3 Inter (o C6 recusa com 422): at\xE9 5 linhas de instru\xE7\xE3o impressas no boleto." }
|
|
1013
1043
|
}
|
|
1014
1044
|
},
|
|
1015
1045
|
Webhook: {
|
|
@@ -1499,9 +1529,9 @@ var SCHEMAS = {
|
|
|
1499
1529
|
properties: {
|
|
1500
1530
|
id: { type: "string", format: "uuid" },
|
|
1501
1531
|
name: { type: "string" },
|
|
1502
|
-
system_key: { type: ["string", "null"], description: "Ex: inter_pix, c6bank_boleto" },
|
|
1503
|
-
channel_key: { type: ["string", "null"], enum: ["pix", "boleto", "checkout", null] },
|
|
1504
|
-
provider_name: { type: ["string", "null"], enum: ["inter", "c6bank", null] },
|
|
1532
|
+
system_key: { type: ["string", "null"], description: "Ex: inter_pix, c6bank_boleto, pagarme_credit_card, inter_pix_automatico. Forma manual (sem integra\xE7\xE3o) volta null." },
|
|
1533
|
+
channel_key: { type: ["string", "null"], enum: ["pix", "boleto", "checkout", "credit_card", "pix_automatico", null], description: "Canal. null = forma manual (dinheiro, transfer\xEAncia\u2026)." },
|
|
1534
|
+
provider_name: { type: ["string", "null"], enum: ["inter", "c6bank", "cora", "pagarme", "mercadopago", "pix_offline", null], description: "Banco/gateway da forma. Em /v1/payment-methods/ap (pagamento a fornecedor) s\xF3 aparecem inter, c6bank e cora. null = forma manual." },
|
|
1505
1535
|
active: { type: "boolean" }
|
|
1506
1536
|
}
|
|
1507
1537
|
},
|
|
@@ -1572,7 +1602,7 @@ var SCHEMAS = {
|
|
|
1572
1602
|
required: ["invoice_id"],
|
|
1573
1603
|
properties: {
|
|
1574
1604
|
invoice_id: { type: "string", format: "uuid", description: "Fatura a partir da qual emitir a NFS-e" },
|
|
1575
|
-
discriminacao: { type: "string", maxLength: 2e3, description: "Opcional. Texto integral da discrimina\xE7\xE3o do servi\xE7o (xDescServ) \u2014 substitui o montado dos itens. Nota autorizada n\xE3o se edita (s\xF3 cancela e reemite), ent\xE3o \xE9 aqui que se acerta o texto. Inclua o n\xFAmero da fatura se quiser que ele apare\xE7a. Sem o campo: n\xFAmero da fatura +
|
|
1605
|
+
discriminacao: { type: "string", maxLength: 2e3, description: "Opcional. Texto integral da discrimina\xE7\xE3o do servi\xE7o (xDescServ) \u2014 substitui o montado dos itens. Nota autorizada n\xE3o se edita (s\xF3 cancela e reemite), ent\xE3o \xE9 aqui que se acerta o texto. Inclua o n\xFAmero da fatura se quiser que ele apare\xE7a. Sem o campo: n\xFAmero da fatura + o `name` de cada item, com a `description` abaixo dele." }
|
|
1576
1606
|
}
|
|
1577
1607
|
},
|
|
1578
1608
|
NfseCancel: {
|
|
@@ -1750,6 +1780,296 @@ var SCHEMAS = {
|
|
|
1750
1780
|
active: { type: "boolean" },
|
|
1751
1781
|
is_default: { type: "boolean", description: "Empresa padr\xE3o da chave (usada quando X-Company-Id \xE9 omitido)" }
|
|
1752
1782
|
}
|
|
1783
|
+
},
|
|
1784
|
+
// ---------------------------------------------------------------- Parcerias (specs/parcerias/)
|
|
1785
|
+
Parceria: {
|
|
1786
|
+
type: "object",
|
|
1787
|
+
description: "Caixa de um trabalho feito em conjunto com quem n\xE3o \xE9 s\xF3cio: a receita entra, o imposto e as despesas comuns saem, e o resto \xE9 dividido entre os participantes.",
|
|
1788
|
+
properties: {
|
|
1789
|
+
id: { type: "string", format: "uuid" },
|
|
1790
|
+
company_id: { type: "string", format: "uuid", description: "Empresa gestora" },
|
|
1791
|
+
nome: { type: "string" },
|
|
1792
|
+
descricao: { type: ["string", "null"] },
|
|
1793
|
+
status: { type: "string", enum: ["ativa", "encerrada"] },
|
|
1794
|
+
data_corte: { type: "string", format: "date", description: "In\xEDcio do livro; antes dela s\xF3 o saldo inicial" },
|
|
1795
|
+
created_at: { type: "string", format: "date-time" },
|
|
1796
|
+
updated_at: { type: "string", format: "date-time" }
|
|
1797
|
+
}
|
|
1798
|
+
},
|
|
1799
|
+
ParceriaResumo: {
|
|
1800
|
+
type: "object",
|
|
1801
|
+
description: "Saldo de cada participante, onde est\xE1 o dinheiro e alertas. total_saldos = total_contas quando o livro fecha.",
|
|
1802
|
+
properties: {
|
|
1803
|
+
participantes: { type: "array", items: { type: "object", properties: {
|
|
1804
|
+
id: { type: "string", format: "uuid" },
|
|
1805
|
+
supplier_id: { type: "string", format: "uuid" },
|
|
1806
|
+
nome: { type: "string" },
|
|
1807
|
+
documento: { type: ["string", "null"] },
|
|
1808
|
+
user_id: { type: ["string", "null"] },
|
|
1809
|
+
percentual_padrao: { type: "number" },
|
|
1810
|
+
natureza_retirada: { type: "string", enum: ["repasse", "distribuicao_lucros"] },
|
|
1811
|
+
exige_nota: { type: "boolean" },
|
|
1812
|
+
ativo: { type: "boolean" },
|
|
1813
|
+
saldo: { type: "number" },
|
|
1814
|
+
notas_pendentes: { type: "number" }
|
|
1815
|
+
} } },
|
|
1816
|
+
onde_esta: { type: "array", items: { type: "object", properties: {
|
|
1817
|
+
bank_account_id: { type: ["string", "null"] },
|
|
1818
|
+
conta: { type: "string" },
|
|
1819
|
+
empresa_id: { type: ["string", "null"] },
|
|
1820
|
+
empresa: { type: ["string", "null"] },
|
|
1821
|
+
valor: { type: "number" }
|
|
1822
|
+
} } },
|
|
1823
|
+
total_saldos: { type: "number" },
|
|
1824
|
+
total_contas: { type: "number" },
|
|
1825
|
+
a_receber: { type: "number", description: "Parcelas em aberto dos contratos e faturas vinculados (informativo)" },
|
|
1826
|
+
impostos_provisorios: { type: "object", properties: { quantidade: { type: "integer" }, valor: { type: "number" } } },
|
|
1827
|
+
impostos_pendentes: { type: "integer", description: "Impostos sem al\xEDquota conhecida (empresa sem c\xE1lculo autom\xE1tico)" },
|
|
1828
|
+
retiradas_sem_despesa: { type: "integer" },
|
|
1829
|
+
eventos_com_erro: { type: "integer", description: "Lan\xE7amentos autom\xE1ticos que falharam e n\xE3o entraram no livro" },
|
|
1830
|
+
meses_fechados: { type: "array", items: { type: "string", format: "date" } }
|
|
1831
|
+
}
|
|
1832
|
+
},
|
|
1833
|
+
ParceriaDetalhe: {
|
|
1834
|
+
allOf: [{ $ref: "#/components/schemas/Parceria" }, { type: "object", properties: { resumo: { $ref: "#/components/schemas/ParceriaResumo" } } }]
|
|
1835
|
+
},
|
|
1836
|
+
ParceriaCreate: {
|
|
1837
|
+
type: "object",
|
|
1838
|
+
required: ["nome", "participantes"],
|
|
1839
|
+
properties: {
|
|
1840
|
+
nome: { type: "string" },
|
|
1841
|
+
descricao: { type: "string" },
|
|
1842
|
+
data_corte: { type: "string", format: "date", description: "Padr\xE3o: hoje" },
|
|
1843
|
+
participantes: {
|
|
1844
|
+
type: "array",
|
|
1845
|
+
minItems: 2,
|
|
1846
|
+
description: "Cada um \xE9 um fornecedor-favorecido da empresa gestora; os percentuais somam 100.",
|
|
1847
|
+
items: { type: "object", required: ["supplier_id", "percentual"], properties: {
|
|
1848
|
+
supplier_id: { type: "string", format: "uuid" },
|
|
1849
|
+
user_id: { type: "string", format: "uuid", description: "Quando o participante \xE9 um usu\xE1rio da empresa" },
|
|
1850
|
+
percentual: { type: "number", minimum: 0, maximum: 100 },
|
|
1851
|
+
saldo_inicial: { type: "number", description: "Saldo na data de corte (pode ser negativo)" },
|
|
1852
|
+
natureza_retirada: { type: "string", enum: ["repasse", "distribuicao_lucros"], description: "repasse = custo com nota do parceiro; distribuicao_lucros = fora do DRE" },
|
|
1853
|
+
exige_nota: { type: "boolean" }
|
|
1854
|
+
} }
|
|
1855
|
+
},
|
|
1856
|
+
empresas: {
|
|
1857
|
+
type: "array",
|
|
1858
|
+
description: "Outras empresas que faturam para a parceria (exige admin nas duas; com chave sem usu\xE1rio, s\xF3 a empresa da chave).",
|
|
1859
|
+
items: { type: "object", required: ["empresa_id"], properties: {
|
|
1860
|
+
empresa_id: { type: "string", format: "uuid" },
|
|
1861
|
+
modo_imposto: { type: "string", enum: ["automatico", "percentual"] },
|
|
1862
|
+
percentual_imposto: { type: "number", minimum: 0, maximum: 100 }
|
|
1863
|
+
} }
|
|
1864
|
+
},
|
|
1865
|
+
saldo_contas: {
|
|
1866
|
+
type: "array",
|
|
1867
|
+
description: "Onde est\xE1 o saldo inicial; a soma tem que ser igual \xE0 soma dos saldos iniciais.",
|
|
1868
|
+
items: { type: "object", required: ["bank_account_id", "valor"], properties: {
|
|
1869
|
+
bank_account_id: { type: "string", format: "uuid" },
|
|
1870
|
+
valor: { type: "number" }
|
|
1871
|
+
} }
|
|
1872
|
+
}
|
|
1873
|
+
}
|
|
1874
|
+
},
|
|
1875
|
+
ParceriaUpdate: {
|
|
1876
|
+
type: "object",
|
|
1877
|
+
properties: {
|
|
1878
|
+
nome: { type: "string" },
|
|
1879
|
+
descricao: { type: ["string", "null"] },
|
|
1880
|
+
status: { type: "string", enum: ["ativa", "encerrada"] }
|
|
1881
|
+
}
|
|
1882
|
+
},
|
|
1883
|
+
ParceriaLancamento: {
|
|
1884
|
+
type: "object",
|
|
1885
|
+
description: "Linha do livro. valor \xE9 o efeito no bolo, com sinal (receita +, imposto \u2212, despesa \u2212, retirada \u2212, transfer\xEAncia 0). O livro \xE9 imut\xE1vel: corre\xE7\xE3o \xE9 estorno.",
|
|
1886
|
+
properties: {
|
|
1887
|
+
id: { type: "string", format: "uuid" },
|
|
1888
|
+
tipo: { type: "string", enum: ["saldo_inicial", "receita", "imposto", "imposto_acerto", "despesa", "retirada", "transferencia", "ajuste", "estorno"] },
|
|
1889
|
+
origem: { type: "string", enum: ["automatico", "manual"] },
|
|
1890
|
+
data: { type: "string", format: "date" },
|
|
1891
|
+
competencia: { type: "string", format: "date" },
|
|
1892
|
+
valor: { type: "number" },
|
|
1893
|
+
descricao: { type: "string" },
|
|
1894
|
+
empresa_id: { type: ["string", "null"] },
|
|
1895
|
+
bank_account_id: { type: ["string", "null"] },
|
|
1896
|
+
bank_account_destino_id: { type: ["string", "null"] },
|
|
1897
|
+
valor_movimentado: { type: ["number", "null"] },
|
|
1898
|
+
participante_id: { type: ["string", "null"] },
|
|
1899
|
+
lancamento_pai_id: { type: ["string", "null"] },
|
|
1900
|
+
aliquota: { type: ["number", "null"] },
|
|
1901
|
+
aliquota_fonte: { type: ["string", "null"] },
|
|
1902
|
+
provisorio: { type: "boolean" },
|
|
1903
|
+
nota_status: { type: "string", enum: ["nao_se_aplica", "pendente", "casada", "dispensada"] },
|
|
1904
|
+
nfse_recebida_id: { type: ["string", "null"] },
|
|
1905
|
+
estornado: { type: "boolean" },
|
|
1906
|
+
motivo: { type: ["string", "null"] },
|
|
1907
|
+
created_at: { type: "string", format: "date-time" },
|
|
1908
|
+
rateio: { type: "array", items: { type: "object", properties: { participante_id: { type: "string", format: "uuid" }, valor: { type: "number" } } } }
|
|
1909
|
+
}
|
|
1910
|
+
},
|
|
1911
|
+
ParceriaLancamentoCreate: {
|
|
1912
|
+
type: "object",
|
|
1913
|
+
required: ["tipo", "data", "descricao"],
|
|
1914
|
+
properties: {
|
|
1915
|
+
tipo: { type: "string", enum: ["receita", "despesa", "transferencia", "ajuste"], description: "Retirada \xE9 POST /parcerias/{id}/retiradas." },
|
|
1916
|
+
valor: { type: "number", exclusiveMinimum: 0, description: "Positivo. N\xE3o se usa em ajuste (o valor \xE9 a soma do rateio)." },
|
|
1917
|
+
data: { type: "string", format: "date" },
|
|
1918
|
+
descricao: { type: "string" },
|
|
1919
|
+
empresa_id: { type: "string", format: "uuid", description: "Obrigat\xF3rio na receita: a empresa que emitiu define o imposto" },
|
|
1920
|
+
bank_account_id: { type: "string", format: "uuid", description: "Conta onde o dinheiro est\xE1; na transfer\xEAncia, a de origem" },
|
|
1921
|
+
bank_account_destino_id: { type: "string", format: "uuid", description: "S\xF3 transfer\xEAncia" },
|
|
1922
|
+
percentuais: { type: "object", additionalProperties: { type: "number" }, description: "Divis\xE3o diferente da padr\xE3o {participante_id: percentual}; exige parcerias:update" },
|
|
1923
|
+
aliquota: { type: "number", minimum: 0, maximum: 100, description: "S\xF3 receita: al\xEDquota \xE0 m\xE3o; exige parcerias:update" },
|
|
1924
|
+
rateio: { type: "object", additionalProperties: { type: "number" }, description: "S\xF3 ajuste: {participante_id: valor com sinal}" },
|
|
1925
|
+
motivo: { type: "string", description: "Obrigat\xF3rio no ajuste" }
|
|
1926
|
+
}
|
|
1927
|
+
},
|
|
1928
|
+
ParceriaRetiradaCreate: {
|
|
1929
|
+
type: "object",
|
|
1930
|
+
required: ["participante_id", "valor", "data", "empresa_id", "bank_account_id"],
|
|
1931
|
+
properties: {
|
|
1932
|
+
participante_id: { type: "string", format: "uuid" },
|
|
1933
|
+
valor: { type: "number", exclusiveMinimum: 0 },
|
|
1934
|
+
data: { type: "string", format: "date" },
|
|
1935
|
+
empresa_id: { type: "string", format: "uuid", description: "Empresa de onde o dinheiro sai (a NFS-e do parceiro tem que ser contra ela)" },
|
|
1936
|
+
bank_account_id: { type: "string", format: "uuid" },
|
|
1937
|
+
descricao: { type: "string" },
|
|
1938
|
+
confirmo_adiantamento: { type: "boolean", description: "Obrigat\xF3rio quando a retirada passa do saldo do participante" },
|
|
1939
|
+
pelo_banco: { type: "boolean", description: "true = pagar pelo banco: vira conta a pagar ao parceiro (Pix/boleto pelo fluxo de contas a pagar, com o 2FA de pagamento) e o lan\xE7amento nasce quando o pagamento \xE9 confirmado. A\xED 'data' \xE9 a data de pagamento (hoje ou depois) e a resposta \xE9 202." }
|
|
1940
|
+
}
|
|
1941
|
+
},
|
|
1942
|
+
ParceriaRetiradaAPagar: {
|
|
1943
|
+
type: "object",
|
|
1944
|
+
description: "Retirada paga pelo banco, ainda a pagar. Pague a parcela da conta a pagar (POST /payouts); o valor fica reservado no saldo do participante.",
|
|
1945
|
+
properties: {
|
|
1946
|
+
id: { type: "string", format: "uuid" },
|
|
1947
|
+
purchase_invoice_id: { type: "string", format: "uuid", description: "Conta a pagar ao parceiro na empresa de origem" },
|
|
1948
|
+
purchase_invoice_charge_id: { type: "string", format: "uuid", description: "Parcela a pagar" },
|
|
1949
|
+
status: { type: "string", enum: ["aguardando"] }
|
|
1950
|
+
}
|
|
1951
|
+
},
|
|
1952
|
+
ParceriaNotaResolve: {
|
|
1953
|
+
type: "object",
|
|
1954
|
+
description: "Casar a retirada com a NFS-e recebida do participante, ou dispensar a nota com motivo.",
|
|
1955
|
+
properties: {
|
|
1956
|
+
nfse_recebida_id: { type: "string", format: "uuid" },
|
|
1957
|
+
dispensar: { type: "boolean" },
|
|
1958
|
+
motivo: { type: "string" }
|
|
1959
|
+
}
|
|
1960
|
+
},
|
|
1961
|
+
ParceriaVinculo: {
|
|
1962
|
+
type: "object",
|
|
1963
|
+
properties: {
|
|
1964
|
+
id: { type: "string", format: "uuid" },
|
|
1965
|
+
tipo: { type: "string", enum: ["contrato", "fatura", "despesa", "despesa_recorrente", "conta_a_pagar", "conta_a_pagar_recorrente", "das_mei"], description: "das_mei: ref_id \xE9 a EMPRESA (MEI) \u2014 a guia do DAS de todo m\xEAs entra como despesa comum quando paga" },
|
|
1966
|
+
ref_id: { type: "string", format: "uuid" },
|
|
1967
|
+
ref_company_id: { type: "string", format: "uuid" },
|
|
1968
|
+
empresa: { type: "string" },
|
|
1969
|
+
titulo: { type: ["string", "null"] },
|
|
1970
|
+
percentuais: { type: ["object", "null"] },
|
|
1971
|
+
desde: { type: "string", format: "date" }
|
|
1972
|
+
}
|
|
1973
|
+
},
|
|
1974
|
+
ParceriaVinculoCreate: {
|
|
1975
|
+
type: "object",
|
|
1976
|
+
required: ["tipo", "ref_id"],
|
|
1977
|
+
properties: {
|
|
1978
|
+
tipo: { type: "string", enum: ["contrato", "fatura", "despesa", "despesa_recorrente", "conta_a_pagar", "conta_a_pagar_recorrente", "das_mei"], description: "das_mei: ref_id \xE9 a EMPRESA (MEI) \u2014 a guia do DAS de todo m\xEAs entra como despesa comum quando paga" },
|
|
1979
|
+
ref_id: { type: "string", format: "uuid" },
|
|
1980
|
+
desde: { type: "string", format: "date", description: "S\xF3 entra o que foi pago a partir daqui (padr\xE3o: a data de corte)" },
|
|
1981
|
+
percentuais: { type: "object", additionalProperties: { type: "number" }, description: "Divis\xE3o pr\xF3pria deste item {participante_id: percentual}" },
|
|
1982
|
+
incluir_antes_do_corte: { type: "boolean", default: false, description: "true deixa 'desde' ser ANTERIOR \xE0 data de corte e lan\xE7a esses pagamentos nas datas reais (s\xF3 admin). Quem pede declara que esse dinheiro N\xC3O est\xE1 no saldo inicial \u2014 o caso t\xEDpico \xE9 recebimento de outra empresa, fora das contas do saldo inicial. Sem ele, 'desde' antes do corte \xE9 empurrado para o corte. Confira antes com GET /parcerias/{id}/vinculos/previa." }
|
|
1983
|
+
}
|
|
1984
|
+
},
|
|
1985
|
+
ParceriaVinculoPrevia: {
|
|
1986
|
+
type: "object",
|
|
1987
|
+
description: "O que um v\xEDnculo traria se fosse feito agora (nada \xE9 gravado).",
|
|
1988
|
+
properties: {
|
|
1989
|
+
data_corte: { type: "string", format: "date" },
|
|
1990
|
+
desde: { type: "string", format: "date", description: "A partir de quando contaria (o 'desde' pedido ou a data de corte)" },
|
|
1991
|
+
quantidade: { type: "integer", description: "Pagamentos que entrariam no livro" },
|
|
1992
|
+
valor: { type: "number" },
|
|
1993
|
+
quantidade_antes_do_corte: { type: "integer", description: "Desses, quantos s\xE3o anteriores ao corte (s\xF3 entram com incluir_antes_do_corte)" },
|
|
1994
|
+
valor_antes_do_corte: { type: "number" },
|
|
1995
|
+
primeiro: { type: ["string", "null"], format: "date" },
|
|
1996
|
+
ultimo: { type: ["string", "null"], format: "date" },
|
|
1997
|
+
em_aberto_quantidade: { type: "integer", description: "Parcelas/despesas do item ainda N\xC3O pagas \u2014 entram sozinhas quando forem pagas" },
|
|
1998
|
+
em_aberto_valor: { type: "number" },
|
|
1999
|
+
em_aberto_proximo_vencimento: { type: ["string", "null"], format: "date" }
|
|
2000
|
+
}
|
|
2001
|
+
},
|
|
2002
|
+
ParceriaParticipantesUpdate: {
|
|
2003
|
+
type: "object",
|
|
2004
|
+
required: ["participantes"],
|
|
2005
|
+
properties: {
|
|
2006
|
+
participantes: {
|
|
2007
|
+
type: "array",
|
|
2008
|
+
minItems: 1,
|
|
2009
|
+
description: "S\xF3 os participantes que MUDAM (quem n\xE3o aparece fica como est\xE1). Depois de salvar, os ativos precisam somar 100%. Tirar quem tem hist\xF3rico (rateio ou lan\xE7amento) o deixa inativo \u2014 o saldo e o passado continuam dele; sem hist\xF3rico, ele \xE9 exclu\xEDdo. Recusado (422) se ainda tem parte numa divis\xE3o pr\xF3pria de v\xEDnculo.",
|
|
2010
|
+
items: { type: "object", properties: {
|
|
2011
|
+
id: { type: "string", format: "uuid", description: "Participante que j\xE1 est\xE1 na parceria (veja resumo.participantes em GET /parcerias/{id})" },
|
|
2012
|
+
supplier_id: { type: "string", format: "uuid", description: "Novo participante (fornecedor-favorecido da empresa gestora). Quem j\xE1 foi participante volta com o mesmo cadastro e o hist\xF3rico." },
|
|
2013
|
+
percentual: { type: "number", minimum: 0, maximum: 100 },
|
|
2014
|
+
natureza_retirada: { type: "string", enum: ["repasse", "distribuicao_lucros"] },
|
|
2015
|
+
exige_nota: { type: "boolean" },
|
|
2016
|
+
user_id: { type: ["string", "null"], description: "Usu\xE1rio da empresa ligado ao participante; '' ou null desliga" },
|
|
2017
|
+
ativo: { type: "boolean", description: "true reativa quem tinha sa\xEDdo; false tira (igual a excluir, mas nunca apaga)" },
|
|
2018
|
+
excluir: { type: "boolean", description: "Tira da parceria (inativo se tem hist\xF3rico, exclu\xEDdo se n\xE3o tem)" }
|
|
2019
|
+
} }
|
|
2020
|
+
}
|
|
2021
|
+
}
|
|
2022
|
+
},
|
|
2023
|
+
ParceriaSaldoInicialUpdate: {
|
|
2024
|
+
type: "object",
|
|
2025
|
+
description: `ESTADO FINAL das contas e do saldo inicial. As duas somas finais t\xEAm de fechar (como na cria\xE7\xE3o). O livro \xE9 imut\xE1vel: a diferen\xE7a de cada participante entra como um novo lan\xE7amento 'saldo_inicial' na data de corte ("Ajuste do saldo inicial"). M\xEAs da data de corte fechado recusa.`,
|
|
2026
|
+
properties: {
|
|
2027
|
+
contas: {
|
|
2028
|
+
type: "array",
|
|
2029
|
+
description: "Onde est\xE1 o saldo inicial. Conta ausente (ou com valor 0) sai.",
|
|
2030
|
+
items: { type: "object", required: ["bank_account_id", "valor"], properties: {
|
|
2031
|
+
bank_account_id: { type: "string", format: "uuid" },
|
|
2032
|
+
valor: { type: "number" }
|
|
2033
|
+
} }
|
|
2034
|
+
},
|
|
2035
|
+
participantes: {
|
|
2036
|
+
type: "array",
|
|
2037
|
+
description: "Saldo inicial de cada um. Participante n\xE3o listado mant\xE9m o que tem.",
|
|
2038
|
+
items: { type: "object", required: ["participante_id", "saldo"], properties: {
|
|
2039
|
+
participante_id: { type: "string", format: "uuid" },
|
|
2040
|
+
saldo: { type: "number" }
|
|
2041
|
+
} }
|
|
2042
|
+
}
|
|
2043
|
+
}
|
|
2044
|
+
},
|
|
2045
|
+
ParceriaEmpresaUpsert: {
|
|
2046
|
+
type: "object",
|
|
2047
|
+
required: ["empresa_id"],
|
|
2048
|
+
properties: {
|
|
2049
|
+
empresa_id: { type: "string", format: "uuid", description: "Empresa que fatura para a parceria. Incluir exige admin nas DUAS empresas \u2014 com chave cmd_live (sem usu\xE1rio) s\xF3 a empresa da chave; para incluir outra, use o chat, o OAuth do MCP ou o JWT de um admin das duas." },
|
|
2050
|
+
modo_imposto: { type: "string", enum: ["automatico", "percentual"], default: "automatico", description: "automatico = al\xEDquota efetiva da empresa; percentual = percentual_imposto fixo" },
|
|
2051
|
+
percentual_imposto: { type: "number", description: "Obrigat\xF3rio com modo_imposto = percentual" }
|
|
2052
|
+
}
|
|
2053
|
+
},
|
|
2054
|
+
ParceriaPrestacao: {
|
|
2055
|
+
type: "object",
|
|
2056
|
+
description: "Presta\xE7\xE3o de contas do m\xEAs: abertura + receitas + impostos + despesas + retiradas + ajustes = fechamento, por participante.",
|
|
2057
|
+
properties: {
|
|
2058
|
+
competencia: { type: "string", description: "AAAA-MM" },
|
|
2059
|
+
participantes: { type: "array", items: { type: "object", properties: {
|
|
2060
|
+
participante_id: { type: "string", format: "uuid" },
|
|
2061
|
+
nome: { type: "string" },
|
|
2062
|
+
abertura: { type: "number" },
|
|
2063
|
+
receitas: { type: "number" },
|
|
2064
|
+
impostos: { type: "number" },
|
|
2065
|
+
despesas: { type: "number" },
|
|
2066
|
+
retiradas: { type: "number" },
|
|
2067
|
+
ajustes: { type: "number" },
|
|
2068
|
+
fechamento: { type: "number" }
|
|
2069
|
+
} } },
|
|
2070
|
+
totais: { type: "object" },
|
|
2071
|
+
lancamentos: { type: "array", items: { type: "object" } }
|
|
2072
|
+
}
|
|
1753
2073
|
}
|
|
1754
2074
|
};
|
|
1755
2075
|
function paginatedResponse(schemaRef) {
|
|
@@ -1837,7 +2157,8 @@ var OPENAPI_SPEC = {
|
|
|
1837
2157
|
{ name: "Pagamentos a Fornecedor", description: "Payouts \u2014 pagar/agendar Pix e boleto a fornecedores" },
|
|
1838
2158
|
{ name: "M\xE9todos de pagamento", description: "Formas de recebimento dispon\xEDveis" },
|
|
1839
2159
|
{ name: "Formas de pagamento do fornecedor", description: "Cadastro de destinos de pagamento por fornecedor" },
|
|
1840
|
-
{ name: "Lembretes", description: "Lembretes e resumos agendados (recorrentes ou avulsos)" }
|
|
2160
|
+
{ name: "Lembretes", description: "Lembretes e resumos agendados (recorrentes ou avulsos)" },
|
|
2161
|
+
{ name: "Parcerias", description: "Caixa compartilhado com parceiro que n\xE3o \xE9 s\xF3cio: receita, imposto, despesas comuns, retiradas e presta\xE7\xE3o de contas" }
|
|
1841
2162
|
],
|
|
1842
2163
|
components: {
|
|
1843
2164
|
securitySchemes: {
|
|
@@ -1897,7 +2218,16 @@ var OPENAPI_SPEC = {
|
|
|
1897
2218
|
status: { type: "string", description: "Status da assinatura (none = sem assinatura paga, Gr\xE1tis)" },
|
|
1898
2219
|
billing_cycle: { type: "string", enum: ["monthly", "yearly"] },
|
|
1899
2220
|
current_period_end: { type: ["string", "null"], format: "date" },
|
|
1900
|
-
courtesy: { type: "boolean", description: "Plano de cortesia (sem cobran\xE7a)" },
|
|
2221
|
+
courtesy: { type: "boolean", description: "Plano de cortesia (sem cobran\xE7a, sem prazo)" },
|
|
2222
|
+
transition_until: { type: ["string", "null"], format: "date", description: "Conta em transi\xE7\xE3o da virada dos planos: at\xE9 a v\xE9spera desta data fica sem cobran\xE7a, com as franquias do Escala; nesse dia passa ao Gr\xE1tis (a menos que escolha um plano)" },
|
|
2223
|
+
features: {
|
|
2224
|
+
type: "object",
|
|
2225
|
+
description: "Recursos que o plano inclui. O Gr\xE1tis n\xE3o envia WhatsApp nem conecta banco automaticamente (extrato por OFX/CSV).",
|
|
2226
|
+
properties: {
|
|
2227
|
+
whatsapp: { type: "boolean" },
|
|
2228
|
+
bank_sync: { type: "boolean", description: "Conex\xE3o autom\xE1tica com o banco (extrato sincronizado)" }
|
|
2229
|
+
}
|
|
2230
|
+
},
|
|
1901
2231
|
usage: {
|
|
1902
2232
|
type: "object",
|
|
1903
2233
|
description: "Uma entrada por franquia: empresas, usuarios, cadastros_mes, cobrancas_mes, nfse_mes, contas_bancarias, sync_bancario, storage_gb, ai_tokens_input_mes, ai_tokens_output_mes, email_mes, whatsapp_mes, lembretes_por_cobranca. `_mes` zera na virada do m\xEAs (hor\xE1rio de Bras\xEDlia); as demais s\xE3o estoque.",
|
|
@@ -1906,7 +2236,10 @@ var OPENAPI_SPEC = {
|
|
|
1906
2236
|
properties: {
|
|
1907
2237
|
used: { type: ["number", "null"], description: "Usado no m\xEAs (ou estoque atual). null quando n\xE3o se mede (lembretes_por_cobranca)" },
|
|
1908
2238
|
limit: { type: ["number", "null"], description: "Limite do plano. null = ilimitado" },
|
|
1909
|
-
unavailable: { type: "boolean", description: "true se esta m\xE9trica n\xE3o p\xF4de ser lida agora" }
|
|
2239
|
+
unavailable: { type: "boolean", description: "true se esta m\xE9trica n\xE3o p\xF4de ser lida agora" },
|
|
2240
|
+
percent: { type: ["integer", "null"], description: "% do limite j\xE1 usado (null sem limite)" },
|
|
2241
|
+
projected: { type: ["integer", "null"], description: "Franquias _mes: uso projetado at\xE9 o fim do m\xEAs no ritmo atual" },
|
|
2242
|
+
level: { type: ["string", "null"], enum: ["previsao", "oitenta", "esgotada", null], description: "Mesmo n\xEDvel do aviso/webhook plan.limit_near: previsao (no ritmo, acaba antes da virada), oitenta (\u2265 80%), esgotada" }
|
|
1910
2243
|
}
|
|
1911
2244
|
}
|
|
1912
2245
|
},
|
|
@@ -2428,7 +2761,7 @@ var OPENAPI_SPEC = {
|
|
|
2428
2761
|
parameters: [
|
|
2429
2762
|
...PAGINATION_PARAMS,
|
|
2430
2763
|
{ name: "search", in: "query", schema: { type: "string" }, description: "Busca por n\xFAmero ou t\xEDtulo" },
|
|
2431
|
-
{ name: "status", in: "query", schema: { type: "string", enum: ["rascunho", "enviada", "aceita", "cancelada"] } },
|
|
2764
|
+
{ name: "status", in: "query", schema: { type: "string", enum: ["rascunho", "enviada", "aceita", "ativa", "cancelada"] } },
|
|
2432
2765
|
{ name: "payment_status", in: "query", schema: { type: "string", enum: ["pendente", "parcial", "pago", "vencido"] } },
|
|
2433
2766
|
{ name: "customer_id", in: "query", schema: { type: "string", format: "uuid" } },
|
|
2434
2767
|
{ name: "due_date_from", in: "query", schema: { type: "string", format: "date" }, description: "Vencimento a partir de (YYYY-MM-DD)" },
|
|
@@ -2534,7 +2867,7 @@ var OPENAPI_SPEC = {
|
|
|
2534
2867
|
security: [{ ApiKeyAuth: ["invoices:send"] }],
|
|
2535
2868
|
requestBody: { required: true, content: { "application/json": { schema: { type: "object", properties: {
|
|
2536
2869
|
enabled: { type: "boolean", default: true, description: "false desliga e volta o canal para manual" },
|
|
2537
|
-
channel: { type: "string", enum: ["manual", "email", "whatsapp", "ambos"], default: "email", description: '"ambos" = e-mail E WhatsApp' },
|
|
2870
|
+
channel: { type: "string", enum: ["manual", "email", "whatsapp", "ambos"], default: "email", description: '"ambos" = e-mail E WhatsApp. WhatsApp \xE9 dos planos pagos (Essencial em diante): no Gr\xE1tis a mensagem n\xE3o \xE9 enviada (cancelada com motivo plano_sem_whatsapp) \u2014 confira plan.features.whatsapp em GET /v1/me' },
|
|
2538
2871
|
days_before: { type: "integer", minimum: 0, maximum: 90, default: 0, description: "dias ANTES do vencimento" }
|
|
2539
2872
|
} } } } },
|
|
2540
2873
|
responses: {
|
|
@@ -3229,7 +3562,7 @@ var OPENAPI_SPEC = {
|
|
|
3229
3562
|
tags: ["NFS-e"],
|
|
3230
3563
|
summary: "Emitir NFS-e",
|
|
3231
3564
|
operationId: "emitNfse",
|
|
3232
|
-
description: "Emite uma NFS-e a partir de uma fatura. O m\xE9todo (certificado/portal) vem da configura\xE7\xE3o da empresa. Pode levar alguns segundos.\n\n**Discrimina\xE7\xE3o do servi\xE7o (o texto que vai \xE0 prefeitura).** Por padr\xE3o \xE9 o n\xFAmero da fatura seguido,
|
|
3565
|
+
description: "Emite uma NFS-e a partir de uma fatura. O m\xE9todo (certificado/portal) vem da configura\xE7\xE3o da empresa. Pode levar alguns segundos.\n\n**Discrimina\xE7\xE3o do servi\xE7o (o texto que vai \xE0 prefeitura).** Por padr\xE3o \xE9 o n\xFAmero da fatura seguido, para cada item, do `name` (t\xEDtulo) e, abaixo dele, do `description`. O t\xEDtulo sempre vai; o `description` vai inteiro se o texto couber na caixa da DANFS-e (19 linhas) \u2014 se n\xE3o couber, entra o que couber e uma linha `\u2026 (+N linhas)` diz quanto ficou de fora. `description` igual ao `name` n\xE3o se repete. Para controlar o texto, mande `discriminacao` (at\xE9 2000 caracteres). Nota autorizada n\xE3o se edita: errou o texto, \xE9 cancelar e reemitir \u2014 por isso confira antes. Um 409 de nota anterior s\xF3 vale para nota `autorizada` ou `transmitindo`; fatura com nota **cancelada** pode ser emitida de novo.\n\n**Os itens da fatura N\xC3O precisam de `service_id`** \u2014 item avulso emite normalmente; a classifica\xE7\xE3o fiscal (cTribNac, cNBS, al\xEDquotas) vem da configura\xE7\xE3o fiscal da empresa e do CNAE padr\xE3o, n\xE3o do item.\n\nC\xF3digos: **201** = autorizada ou em transmiss\xE3o \u2014 o `id` devolvido \xE9 o mesmo `{id}` de `/v1/nfse/{id}`, `/files`, `/sync` e `/cancel`. **422 com `status: 'rejeitada'`** = o fisco REJEITOU (motivo em `message`) \u2014 n\xE3o existe nota, n\xE3o afirme ao usu\xE1rio que foi emitida. **422 sem `status`** = a EMPRESA n\xE3o est\xE1 configurada para emitir. **409** = esta fatura j\xE1 tem nota (o `error` traz o id da existente). **424** = o provedor fiscal falhou; o motivo dele vem em `error`.\n\nRetentativa \xE9 segura: mande o header `Idempotency-Key` (a mesma resposta volta, com `Idempotent-Replayed: true`), e mesmo sem ele o 409 impede uma segunda nota para a mesma fatura.",
|
|
3233
3566
|
security: [{ ApiKeyAuth: ["nfse:emitir"] }],
|
|
3234
3567
|
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/NfseEmit" } } } },
|
|
3235
3568
|
responses: { "201": { description: "Emiss\xE3o solicitada", content: { "application/json": { schema: { type: "object", properties: { id: { type: ["string", "null"], description: "Id da NFS-e \u2014 use em /v1/nfse/{id}, /files, /sync e /cancel. Mesmo valor de history_id." }, invoice_id: { type: "string" }, status: { type: "string", description: "autorizada | transmitindo | rejeitada" }, numero_nfse: { type: ["string", "null"] }, chave_acesso: { type: ["string", "null"] }, history_id: { type: ["string", "null"], description: "Alias de `id`, mantido por compatibilidade." }, message: { type: ["string", "null"] } } } } } }, "400": errorResponse("invoice_id ausente"), "404": errorResponse("Fatura n\xE3o encontrada"), "409": errorResponse("A fatura j\xE1 tem NFS-e autorizada ou em transmiss\xE3o \u2014 o `error` traz o id da existente"), "402": errorResponse("Saldo insuficiente na carteira pr\xE9-paga (ou limite de gasto atingido) \u2014 nada foi transmitido. `code`: saldo_insuficiente | limite_de_gasto_atingido | carteira_inativa; recarregue em Cobran\xE7a da plataforma"), "422": errorResponse('Rejeitada pelo fisco (corpo traz `status: "rejeitada"` e `message`) OU empresa sem NFS-e configurada (corpo traz s\xF3 `error`)'), "424": errorResponse("O provedor de NFS-e falhou \u2014 o motivo dele vem em `error`"), ...COMMON_ERRORS }
|
|
@@ -3502,6 +3835,52 @@ var OPENAPI_SPEC = {
|
|
|
3502
3835
|
responses: { "200": { description: "Cancelada", content: { "application/json": { schema: { $ref: "#/components/schemas/PurchaseInvoice" } } } }, "404": errorResponse("Conta a pagar n\xE3o encontrada"), "409": errorResponse("J\xE1 cancelada"), ...COMMON_ERRORS }
|
|
3503
3836
|
}
|
|
3504
3837
|
},
|
|
3838
|
+
"/purchase-invoices/{id}/pay": {
|
|
3839
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
3840
|
+
post: {
|
|
3841
|
+
tags: ["Contas a Pagar"],
|
|
3842
|
+
summary: "Registrar pagamento (baixa manual) de uma parcela",
|
|
3843
|
+
operationId: "payPurchaseInvoice",
|
|
3844
|
+
description: 'O "Marcar como pago" da tela: grava que a parcela foi paga \u2014 de qual conta, por qual forma, em que data, parcial ou total, com juros, multa e desconto. N\xC3O move dinheiro no banco (para pagar pelo Inter/C6 use POST /v1/payouts). A parcela e a conta passam a `pago`/`parcial` pelo pr\xF3prio banco, a despesa vinculada a uma parceria entra no livro e o webhook purchase_invoice.paid dispara quando a conta quita. At\xF4mico: dois pedidos iguais n\xE3o baixam o mesmo saldo duas vezes. `amount` \xE9 quanto da PARCELA foi baixado; o que saiu da conta \xE9 amount + interest + fine \u2212 discount. Campo de corpo que a rota n\xE3o conhece devolve 400.',
|
|
3845
|
+
security: [{ ApiKeyAuth: ["purchase_invoices:settle"] }],
|
|
3846
|
+
requestBody: { required: true, content: { "application/json": { schema: { type: "object", required: ["bank_account_id"], properties: {
|
|
3847
|
+
charge_id: { type: "string", format: "uuid", description: "Parcela paga (purchase_invoice_charges.id, veja GET /v1/purchase-invoices/{id}). Obrigat\xF3rio quando a conta tem mais de uma parcela; com uma s\xF3, \xE9 ela." },
|
|
3848
|
+
amount: { type: "number", description: "Quanto da parcela est\xE1 sendo baixado. Omitido, quita o saldo em aberto. Acima do saldo: 409 (o excedente \xE9 juros ou multa)." },
|
|
3849
|
+
interest: { type: "number", minimum: 0, description: "Juros pagos al\xE9m do valor da parcela" },
|
|
3850
|
+
fine: { type: "number", minimum: 0, description: "Multa paga al\xE9m do valor da parcela" },
|
|
3851
|
+
discount: { type: "number", minimum: 0, description: "Desconto obtido sobre o valor baixado" },
|
|
3852
|
+
payment_date: { type: "string", format: "date", description: "Data do pagamento (YYYY-MM-DD). Padr\xE3o: hoje (America/Sao_Paulo)." },
|
|
3853
|
+
payment_method_id: { type: "string", format: "uuid", description: "Forma de PAGAMENTO a fornecedor (GET /v1/payment-methods/ap)" },
|
|
3854
|
+
bank_account_id: { type: "string", format: "uuid", description: "Conta de onde saiu o dinheiro (GET /v1/bank-accounts). Saldo de gateway e cart\xE3o de cr\xE9dito s\xE3o recusados." },
|
|
3855
|
+
notes: { type: "string" }
|
|
3856
|
+
} } } } },
|
|
3857
|
+
responses: {
|
|
3858
|
+
"201": { description: "Pagamento registrado", content: { "application/json": { schema: { type: "object", properties: {
|
|
3859
|
+
payment_id: { type: "string", format: "uuid" },
|
|
3860
|
+
purchase_invoice_id: { type: "string" },
|
|
3861
|
+
purchase_invoice_payment_status: { type: "string", enum: ["pendente", "parcial", "pago", "vencido"] },
|
|
3862
|
+
amount: { type: "number", description: "Baixado da parcela" },
|
|
3863
|
+
interest: { type: "number" },
|
|
3864
|
+
fine: { type: "number" },
|
|
3865
|
+
discount: { type: "number" },
|
|
3866
|
+
total_paid: { type: "number", description: "O que saiu da conta" },
|
|
3867
|
+
payment_date: { type: "string", format: "date" },
|
|
3868
|
+
charge: { type: ["object", "null"], properties: {
|
|
3869
|
+
id: { type: "string" },
|
|
3870
|
+
sequence: { type: ["integer", "null"] },
|
|
3871
|
+
amount: { type: "number" },
|
|
3872
|
+
paid_amount: { type: "number" },
|
|
3873
|
+
remaining_amount: { type: "number" },
|
|
3874
|
+
payment_status: { type: ["string", "null"] }
|
|
3875
|
+
} }
|
|
3876
|
+
} } } } },
|
|
3877
|
+
"400": errorResponse("Campo inv\xE1lido, parcela n\xE3o informada numa conta parcelada, conta banc\xE1ria ou forma de outra empresa"),
|
|
3878
|
+
"404": errorResponse("Conta a pagar ou parcela n\xE3o encontrada"),
|
|
3879
|
+
"409": errorResponse("Conta cancelada, parcela j\xE1 paga ou valor acima do saldo"),
|
|
3880
|
+
...COMMON_ERRORS
|
|
3881
|
+
}
|
|
3882
|
+
}
|
|
3883
|
+
},
|
|
3505
3884
|
// -----------------------------------------------------------------------
|
|
3506
3885
|
// Cobranças (Gateway)
|
|
3507
3886
|
// -----------------------------------------------------------------------
|
|
@@ -3531,6 +3910,7 @@ var OPENAPI_SPEC = {
|
|
|
3531
3910
|
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ChargeCreate" } } } },
|
|
3532
3911
|
responses: {
|
|
3533
3912
|
"201": { description: "Cobran\xE7a criada", content: { "application/json": { schema: { $ref: "#/components/schemas/Charge" } } } },
|
|
3913
|
+
"200": { description: "A parcela j\xE1 tinha cobran\xE7a viva: ela foi devolvida (`reused: true`), sem emitir outra no banco. Para reemitir com outro valor/vencimento, cancele (DELETE) e crie de novo.", content: { "application/json": { schema: { $ref: "#/components/schemas/Charge" } } } },
|
|
3534
3914
|
"400": errorResponse("Dados inv\xE1lidos"),
|
|
3535
3915
|
"409": errorResponse("Fatura j\xE1 paga"),
|
|
3536
3916
|
"422": errorResponse("Integra\xE7\xE3o banc\xE1ria n\xE3o configurada"),
|
|
@@ -3555,6 +3935,17 @@ var OPENAPI_SPEC = {
|
|
|
3555
3935
|
responses: { "200": { description: "Cancelamento solicitado" }, "404": errorResponse("Cobran\xE7a n\xE3o encontrada"), "409": errorResponse("Cobran\xE7a n\xE3o pode ser cancelada no estado atual"), ...COMMON_ERRORS }
|
|
3556
3936
|
}
|
|
3557
3937
|
},
|
|
3938
|
+
"/charges/{id}/pdf": {
|
|
3939
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
3940
|
+
get: {
|
|
3941
|
+
tags: ["Cobran\xE7as"],
|
|
3942
|
+
summary: "PDF do boleto",
|
|
3943
|
+
operationId: "getChargePdf",
|
|
3944
|
+
description: "Devolve `pdf_url` (URL assinada). No Banco Inter o boleto nasce EM_PROCESSAMENTO e o PDF s\xF3 existe quando o banco conclui (minutos): enquanto isso responde 202 com `retry_after_seconds`; chamar a rota tamb\xE9m consulta o banco e avan\xE7a o status.",
|
|
3945
|
+
security: [{ ApiKeyAuth: ["charges:read"] }],
|
|
3946
|
+
responses: { "200": { description: "PDF pronto", content: { "application/json": { schema: { type: "object", properties: { id: { type: "string" }, status_raw: { type: "string" }, pdf_url: { type: "string" } } } } } }, "202": { description: "Banco ainda processando" }, "404": errorResponse("Cobran\xE7a sem PDF ou inexistente"), ...COMMON_ERRORS }
|
|
3947
|
+
}
|
|
3948
|
+
},
|
|
3558
3949
|
"/charges/{id}/refund": {
|
|
3559
3950
|
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
3560
3951
|
post: {
|
|
@@ -4301,6 +4692,238 @@ var OPENAPI_SPEC = {
|
|
|
4301
4692
|
}
|
|
4302
4693
|
},
|
|
4303
4694
|
// -----------------------------------------------------------------------
|
|
4695
|
+
// Parcerias (specs/parcerias/)
|
|
4696
|
+
// -----------------------------------------------------------------------
|
|
4697
|
+
"/parcerias": {
|
|
4698
|
+
get: {
|
|
4699
|
+
tags: ["Parcerias"],
|
|
4700
|
+
summary: "Listar parcerias",
|
|
4701
|
+
operationId: "listParcerias",
|
|
4702
|
+
security: [{ ApiKeyAuth: ["parcerias:list"] }],
|
|
4703
|
+
parameters: [...PAGINATION_PARAMS, { name: "status", in: "query", schema: { type: "string", enum: ["ativa", "encerrada"] } }],
|
|
4704
|
+
responses: { "200": paginatedResponse("#/components/schemas/Parceria"), ...COMMON_ERRORS }
|
|
4705
|
+
},
|
|
4706
|
+
post: {
|
|
4707
|
+
tags: ["Parcerias"],
|
|
4708
|
+
summary: "Criar parceria",
|
|
4709
|
+
operationId: "createParceria",
|
|
4710
|
+
description: "Cria a parceria na empresa da chave, com os participantes (percentuais somam 100), as empresas vinculadas e o saldo inicial.",
|
|
4711
|
+
security: [{ ApiKeyAuth: ["parcerias:create"] }],
|
|
4712
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaCreate" } } } },
|
|
4713
|
+
responses: { "201": { description: "Criada", content: { "application/json": { schema: { $ref: "#/components/schemas/Parceria" } } } }, "422": errorResponse("Regra da parceria recusada (percentuais, saldo inicial, empresa)"), ...COMMON_ERRORS }
|
|
4714
|
+
}
|
|
4715
|
+
},
|
|
4716
|
+
"/parcerias/{id}": {
|
|
4717
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4718
|
+
get: {
|
|
4719
|
+
tags: ["Parcerias"],
|
|
4720
|
+
summary: "Obter parceria com o resumo (saldos e onde est\xE1 o dinheiro)",
|
|
4721
|
+
operationId: "getParceria",
|
|
4722
|
+
security: [{ ApiKeyAuth: ["parcerias:list"] }],
|
|
4723
|
+
responses: { "200": { description: "Parceria", content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaDetalhe" } } } }, "404": errorResponse("Parceria n\xE3o encontrada"), ...COMMON_ERRORS }
|
|
4724
|
+
},
|
|
4725
|
+
patch: {
|
|
4726
|
+
tags: ["Parcerias"],
|
|
4727
|
+
summary: "Atualizar nome, descri\xE7\xE3o ou situa\xE7\xE3o",
|
|
4728
|
+
operationId: "updateParceria",
|
|
4729
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4730
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaUpdate" } } } },
|
|
4731
|
+
responses: { "200": { description: "Atualizada", content: { "application/json": { schema: { $ref: "#/components/schemas/Parceria" } } } }, "404": errorResponse("Parceria n\xE3o encontrada"), ...COMMON_ERRORS }
|
|
4732
|
+
},
|
|
4733
|
+
delete: {
|
|
4734
|
+
tags: ["Parcerias"],
|
|
4735
|
+
summary: "Encerrar parceria",
|
|
4736
|
+
operationId: "closeParceria",
|
|
4737
|
+
description: "N\xE3o apaga: o livro fica. A parceria para de receber lan\xE7amentos (reabra com PATCH status=ativa).",
|
|
4738
|
+
security: [{ ApiKeyAuth: ["parcerias:delete"] }],
|
|
4739
|
+
responses: { "200": { description: "Encerrada", content: { "application/json": { schema: { type: "object", properties: { id: { type: "string" }, status: { type: "string" } } } } } }, "404": errorResponse("Parceria n\xE3o encontrada"), ...COMMON_ERRORS }
|
|
4740
|
+
}
|
|
4741
|
+
},
|
|
4742
|
+
"/parcerias/{id}/lancamentos": {
|
|
4743
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4744
|
+
get: {
|
|
4745
|
+
tags: ["Parcerias"],
|
|
4746
|
+
summary: "Livro de lan\xE7amentos (com o rateio de cada um)",
|
|
4747
|
+
operationId: "listParceriaLancamentos",
|
|
4748
|
+
security: [{ ApiKeyAuth: ["parcerias:list"] }],
|
|
4749
|
+
parameters: [
|
|
4750
|
+
...PAGINATION_PARAMS,
|
|
4751
|
+
{ name: "competencia", in: "query", schema: { type: "string", pattern: "^\\d{4}-\\d{2}$" }, description: "M\xEAs do caixa, AAAA-MM" },
|
|
4752
|
+
{ name: "tipo", in: "query", schema: { type: "string", enum: ["saldo_inicial", "receita", "imposto", "imposto_acerto", "despesa", "retirada", "transferencia", "ajuste", "estorno"] } },
|
|
4753
|
+
{ name: "participante_id", in: "query", schema: { type: "string", format: "uuid" }, description: "S\xF3 retiradas deste participante" }
|
|
4754
|
+
],
|
|
4755
|
+
responses: { "200": paginatedResponse("#/components/schemas/ParceriaLancamento"), "404": errorResponse("Parceria n\xE3o encontrada"), ...COMMON_ERRORS }
|
|
4756
|
+
},
|
|
4757
|
+
post: {
|
|
4758
|
+
tags: ["Parcerias"],
|
|
4759
|
+
summary: "Lan\xE7amento manual (receita, despesa comum, transfer\xEAncia ou ajuste)",
|
|
4760
|
+
operationId: "createParceriaLancamento",
|
|
4761
|
+
description: "Receita, despesa e transfer\xEAncia na divis\xE3o padr\xE3o e na al\xEDquota da empresa: parcerias:create. Ajuste, al\xEDquota \xE0 m\xE3o ou divis\xE3o pr\xF3pria: parcerias:update.",
|
|
4762
|
+
security: [{ ApiKeyAuth: ["parcerias:create"] }, { ApiKeyAuth: ["parcerias:update"] }],
|
|
4763
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaLancamentoCreate" } } } },
|
|
4764
|
+
responses: { "201": { description: "Lan\xE7ado", content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaLancamento" } } } }, "422": errorResponse("Regra da parceria recusada (m\xEAs fechado, empresa, percentuais)"), ...COMMON_ERRORS }
|
|
4765
|
+
}
|
|
4766
|
+
},
|
|
4767
|
+
"/parcerias/{id}/lancamentos/{lancamento_id}/estornar": {
|
|
4768
|
+
parameters: [
|
|
4769
|
+
{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } },
|
|
4770
|
+
{ name: "lancamento_id", in: "path", required: true, schema: { type: "string", format: "uuid" } }
|
|
4771
|
+
],
|
|
4772
|
+
post: {
|
|
4773
|
+
tags: ["Parcerias"],
|
|
4774
|
+
summary: "Estornar lan\xE7amento",
|
|
4775
|
+
operationId: "reverseParceriaLancamento",
|
|
4776
|
+
description: "Lan\xE7a o estorno (e o dos impostos filhos). Estornar retirada cancela a despesa gerada na empresa de origem.",
|
|
4777
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4778
|
+
requestBody: { required: true, content: { "application/json": { schema: { type: "object", required: ["motivo"], properties: { motivo: { type: "string" } } } } } },
|
|
4779
|
+
responses: { "200": { description: "Estornado", content: { "application/json": { schema: { type: "object", properties: { id: { type: "string" }, estornados: { type: "integer" } } } } } }, "422": errorResponse("N\xE3o pode estornar"), ...COMMON_ERRORS }
|
|
4780
|
+
}
|
|
4781
|
+
},
|
|
4782
|
+
"/parcerias/{id}/retiradas": {
|
|
4783
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4784
|
+
post: {
|
|
4785
|
+
tags: ["Parcerias"],
|
|
4786
|
+
summary: "Registrar retirada de participante",
|
|
4787
|
+
operationId: "createParceriaRetirada",
|
|
4788
|
+
description: "Vira uma despesa paga na empresa de origem (repasse ou distribui\xE7\xE3o de lucros). Com pelo_banco=true vira conta a pagar ao parceiro, paga pelo banco, e entra no livro quando o pagamento confirmar. Participante que exige nota fica com nota pendente at\xE9 a NFS-e dele ser casada (casa sozinha quando o valor bate).",
|
|
4789
|
+
security: [{ ApiKeyAuth: ["parcerias:retirar"] }],
|
|
4790
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaRetiradaCreate" } } } },
|
|
4791
|
+
responses: { "201": { description: "Registrada", content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaLancamento" } } } }, "202": { description: "pelo_banco: conta a pagar criada; entra no livro quando o pagamento for confirmado", content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaRetiradaAPagar" } } } }, "422": errorResponse("Saldo insuficiente sem confirmar adiantamento, conta de outra empresa, m\xEAs fechado, data de pagamento no passado"), ...COMMON_ERRORS }
|
|
4792
|
+
}
|
|
4793
|
+
},
|
|
4794
|
+
"/parcerias/{id}/retiradas/{lancamento_id}/nota": {
|
|
4795
|
+
parameters: [
|
|
4796
|
+
{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } },
|
|
4797
|
+
{ name: "lancamento_id", in: "path", required: true, schema: { type: "string", format: "uuid" } }
|
|
4798
|
+
],
|
|
4799
|
+
post: {
|
|
4800
|
+
tags: ["Parcerias"],
|
|
4801
|
+
summary: "Casar a nota da retirada (ou dispensar)",
|
|
4802
|
+
operationId: "resolveParceriaNota",
|
|
4803
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4804
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaNotaResolve" } } } },
|
|
4805
|
+
responses: { "200": { description: "Resolvida", content: { "application/json": { schema: { type: "object", properties: { id: { type: "string" }, nota_status: { type: "string" }, nfse_recebida_id: { type: "string" } } } } } }, "422": errorResponse("Nota de outro CNPJ, j\xE1 usada, ou retirada que n\xE3o est\xE1 pendente"), ...COMMON_ERRORS }
|
|
4806
|
+
}
|
|
4807
|
+
},
|
|
4808
|
+
"/parcerias/{id}/vinculos": {
|
|
4809
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4810
|
+
get: {
|
|
4811
|
+
tags: ["Parcerias"],
|
|
4812
|
+
summary: "Contratos, faturas e despesas que alimentam a parceria",
|
|
4813
|
+
operationId: "listParceriaVinculos",
|
|
4814
|
+
security: [{ ApiKeyAuth: ["parcerias:list"] }],
|
|
4815
|
+
responses: { "200": { description: "V\xEDnculos", content: { "application/json": { schema: { type: "object", properties: { data: { type: "array", items: { $ref: "#/components/schemas/ParceriaVinculo" } } } } } } }, ...COMMON_ERRORS }
|
|
4816
|
+
},
|
|
4817
|
+
post: {
|
|
4818
|
+
tags: ["Parcerias"],
|
|
4819
|
+
summary: "Vincular contrato, fatura, despesa ou conta a pagar",
|
|
4820
|
+
operationId: "createParceriaVinculo",
|
|
4821
|
+
description: "O que j\xE1 foi pago desde 'desde' entra na hora; os pagamentos seguintes entram sozinhos. Um item pertence a uma parceria s\xF3.",
|
|
4822
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4823
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaVinculoCreate" } } } },
|
|
4824
|
+
responses: { "201": { description: "Vinculado", content: { "application/json": { schema: { type: "object", properties: { vinculo_id: { type: "string" }, lancados: { type: "integer" } } } } } }, "422": errorResponse("Item de empresa fora da parceria, j\xE1 em outra parceria ou com Split ativo"), ...COMMON_ERRORS }
|
|
4825
|
+
}
|
|
4826
|
+
},
|
|
4827
|
+
"/parcerias/{id}/vinculos/{vinculo_id}": {
|
|
4828
|
+
parameters: [
|
|
4829
|
+
{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } },
|
|
4830
|
+
{ name: "vinculo_id", in: "path", required: true, schema: { type: "string", format: "uuid" } }
|
|
4831
|
+
],
|
|
4832
|
+
delete: {
|
|
4833
|
+
tags: ["Parcerias"],
|
|
4834
|
+
summary: "Desvincular (para de alimentar; o que j\xE1 entrou fica no livro)",
|
|
4835
|
+
operationId: "deleteParceriaVinculo",
|
|
4836
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4837
|
+
responses: { "200": { description: "Removido", content: { "application/json": { schema: { type: "object", properties: { id: { type: "string" }, removido: { type: "boolean" } } } } } }, ...COMMON_ERRORS }
|
|
4838
|
+
},
|
|
4839
|
+
patch: {
|
|
4840
|
+
tags: ["Parcerias"],
|
|
4841
|
+
summary: "Antecipar o in\xEDcio do v\xEDnculo (trazer pagamentos anteriores)",
|
|
4842
|
+
operationId: "updateParceriaVinculo",
|
|
4843
|
+
description: "Muda o 'a partir de' de um v\xEDnculo j\xE1 feito para MAIS CEDO e lan\xE7a na hora os pagamentos que faltaram. Data anterior ao corte exige admin e tem o mesmo significado de incluir_antes_do_corte (o dinheiro n\xE3o est\xE1 no saldo inicial). Data igual ou posterior \xE0 atual \xE9 recusada (422).",
|
|
4844
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4845
|
+
requestBody: { required: true, content: { "application/json": { schema: { type: "object", required: ["desde"], properties: { desde: { type: "string", format: "date", description: "Nova data de in\xEDcio, anterior \xE0 atual" } } } } } },
|
|
4846
|
+
responses: { "200": { description: "Antecipado", content: { "application/json": { schema: { type: "object", properties: { vinculo_id: { type: "string" }, desde: { type: "string", format: "date" }, lancados: { type: "integer", description: "Pagamentos lan\xE7ados agora" } } } } } }, "422": errorResponse("Data n\xE3o \xE9 anterior \xE0 atual, ou papel insuficiente para ir antes do corte"), ...COMMON_ERRORS }
|
|
4847
|
+
}
|
|
4848
|
+
},
|
|
4849
|
+
"/parcerias/{id}/vinculos/previa": {
|
|
4850
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4851
|
+
get: {
|
|
4852
|
+
tags: ["Parcerias"],
|
|
4853
|
+
summary: "Pr\xE9via de um v\xEDnculo (o que entraria, antes de vincular)",
|
|
4854
|
+
operationId: "previewParceriaVinculo",
|
|
4855
|
+
description: "N\xE3o grava nada. Diz quantos pagamentos do item entrariam no livro e quanto (e quantos s\xE3o anteriores \xE0 data de corte), mais o que est\xE1 EM ABERTO \u2014 parcelas ainda n\xE3o pagas, que entram sozinhas quando forem pagas. Use antes de POST /parcerias/{id}/vinculos para decidir 'desde' e incluir_antes_do_corte.",
|
|
4856
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4857
|
+
parameters: [
|
|
4858
|
+
{ name: "tipo", in: "query", required: true, schema: { type: "string", enum: ["contrato", "fatura", "despesa", "despesa_recorrente", "conta_a_pagar", "conta_a_pagar_recorrente", "das_mei"] } },
|
|
4859
|
+
{ name: "ref_id", in: "query", required: true, schema: { type: "string", format: "uuid" }, description: "Id do item (das_mei: id da empresa MEI)" },
|
|
4860
|
+
{ name: "desde", in: "query", schema: { type: "string", format: "date" }, description: "A partir de quando contar (padr\xE3o: a data de corte)" }
|
|
4861
|
+
],
|
|
4862
|
+
responses: { "200": { description: "Pr\xE9via", content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaVinculoPrevia" } } } }, "422": errorResponse("Item n\xE3o encontrado"), ...COMMON_ERRORS }
|
|
4863
|
+
}
|
|
4864
|
+
},
|
|
4865
|
+
"/parcerias/{id}/participantes": {
|
|
4866
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4867
|
+
patch: {
|
|
4868
|
+
tags: ["Parcerias"],
|
|
4869
|
+
summary: "Incluir, alterar ou tirar participantes",
|
|
4870
|
+
operationId: "updateParceriaParticipantes",
|
|
4871
|
+
description: "Edita os participantes de uma parceria j\xE1 criada: inclui (supplier_id), muda divis\xE3o, natureza da retirada e exig\xEAncia de nota (id), tira (excluir) ou reativa (ativo=true). S\xF3 admin. Devolve a parceria com o resumo atualizado.",
|
|
4872
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4873
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaParticipantesUpdate" } } } },
|
|
4874
|
+
responses: { "200": { description: "Salvo", content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaDetalhe" } } } }, "422": errorResponse("Ativos n\xE3o somam 100%, participante de outra parceria, ou com parte numa divis\xE3o pr\xF3pria de v\xEDnculo"), ...COMMON_ERRORS }
|
|
4875
|
+
}
|
|
4876
|
+
},
|
|
4877
|
+
"/parcerias/{id}/saldo-inicial": {
|
|
4878
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4879
|
+
patch: {
|
|
4880
|
+
tags: ["Parcerias"],
|
|
4881
|
+
summary: "Editar contas e saldo inicial",
|
|
4882
|
+
operationId: "updateParceriaSaldoInicial",
|
|
4883
|
+
description: "Corrige onde est\xE1 e de quem \xE9 o saldo inicial depois de criada (por exemplo, ao incluir uma empresa cuja conta ficou de fora). S\xF3 admin.",
|
|
4884
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4885
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaSaldoInicialUpdate" } } } },
|
|
4886
|
+
responses: { "200": { description: "Salvo", content: { "application/json": { schema: { type: "object", properties: { mudancas: { type: "array", items: { type: "string" }, description: "O que mudou, em portugu\xEAs (vai tamb\xE9m no motivo do lan\xE7amento de ajuste)" } } } } } }, "422": errorResponse("Somas n\xE3o fecham, conta de empresa fora da parceria, ou m\xEAs da data de corte fechado"), ...COMMON_ERRORS }
|
|
4887
|
+
}
|
|
4888
|
+
},
|
|
4889
|
+
"/parcerias/{id}/empresas": {
|
|
4890
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4891
|
+
post: {
|
|
4892
|
+
tags: ["Parcerias"],
|
|
4893
|
+
summary: "Incluir empresa (ou mudar o imposto dela)",
|
|
4894
|
+
operationId: "upsertParceriaEmpresa",
|
|
4895
|
+
description: "Inclui uma empresa que fatura para a parceria, ou, se ela j\xE1 est\xE1, troca a regra de imposto \u2014 e os impostos provis\xF3rios/pendentes dela s\xE3o recalculados. Membros da empresa inclu\xEDda passam a LER a parceria na tela; escrever continua exigindo o papel na gestora. Sem papel admin na empresa a incluir: 403.",
|
|
4896
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4897
|
+
requestBody: { required: true, content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaEmpresaUpsert" } } } },
|
|
4898
|
+
responses: { "200": { description: "Inclu\xEDda/atualizada", content: { "application/json": { schema: { type: "object", properties: { empresa_id: { type: "string" }, impostos_recalculados: { type: "integer" } } } } } }, ...COMMON_ERRORS }
|
|
4899
|
+
}
|
|
4900
|
+
},
|
|
4901
|
+
"/parcerias/{id}/empresas/{empresa_id}": {
|
|
4902
|
+
parameters: [
|
|
4903
|
+
{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } },
|
|
4904
|
+
{ name: "empresa_id", in: "path", required: true, schema: { type: "string", format: "uuid" } }
|
|
4905
|
+
],
|
|
4906
|
+
delete: {
|
|
4907
|
+
tags: ["Parcerias"],
|
|
4908
|
+
summary: "Tirar empresa da parceria",
|
|
4909
|
+
operationId: "deleteParceriaEmpresa",
|
|
4910
|
+
description: "S\xF3 se nada dela entrou no livro nem est\xE1 vinculado (o hist\xF3rico depende dela), e nunca a gestora.",
|
|
4911
|
+
security: [{ ApiKeyAuth: ["parcerias:update"] }],
|
|
4912
|
+
responses: { "200": { description: "Removida", content: { "application/json": { schema: { type: "object", properties: { empresa_id: { type: "string" }, removida: { type: "boolean" } } } } } }, "422": errorResponse("Empresa gestora, ou com lan\xE7amento/v\xEDnculo na parceria"), ...COMMON_ERRORS }
|
|
4913
|
+
}
|
|
4914
|
+
},
|
|
4915
|
+
"/parcerias/{id}/prestacao-de-contas": {
|
|
4916
|
+
parameters: [{ name: "id", in: "path", required: true, schema: { type: "string", format: "uuid" } }],
|
|
4917
|
+
get: {
|
|
4918
|
+
tags: ["Parcerias"],
|
|
4919
|
+
summary: "Presta\xE7\xE3o de contas do m\xEAs",
|
|
4920
|
+
operationId: "getParceriaPrestacao",
|
|
4921
|
+
security: [{ ApiKeyAuth: ["parcerias:list"] }],
|
|
4922
|
+
parameters: [{ name: "competencia", in: "query", schema: { type: "string", pattern: "^\\d{4}-\\d{2}$" }, description: "AAAA-MM (padr\xE3o: m\xEAs atual)" }],
|
|
4923
|
+
responses: { "200": { description: "Presta\xE7\xE3o de contas", content: { "application/json": { schema: { $ref: "#/components/schemas/ParceriaPrestacao" } } } }, ...COMMON_ERRORS }
|
|
4924
|
+
}
|
|
4925
|
+
},
|
|
4926
|
+
// -----------------------------------------------------------------------
|
|
4304
4927
|
// Formas de pagamento do fornecedor
|
|
4305
4928
|
// -----------------------------------------------------------------------
|
|
4306
4929
|
"/suppliers/{id}/payment-methods": {
|
|
@@ -4355,8 +4978,8 @@ var OPENAPI_SPEC = {
|
|
|
4355
4978
|
parameters: [
|
|
4356
4979
|
...PAGINATION_PARAMS,
|
|
4357
4980
|
{ name: "active", in: "query", schema: { type: "string", enum: ["true", "false"] } },
|
|
4358
|
-
{ name: "provider", in: "query", schema: { type: "string", enum: ["inter", "c6bank"] } },
|
|
4359
|
-
{ name: "channel", in: "query", schema: { type: "string", enum: ["pix", "boleto", "checkout", "credit_card"] } },
|
|
4981
|
+
{ name: "provider", in: "query", schema: { type: "string", enum: ["inter", "c6bank", "cora", "pagarme", "mercadopago", "pix_offline"] } },
|
|
4982
|
+
{ name: "channel", in: "query", schema: { type: "string", enum: ["pix", "boleto", "checkout", "credit_card", "pix_automatico"] } },
|
|
4360
4983
|
{ name: "all", in: "query", description: "true lista TODAS as formas cadastradas; por padr\xE3o s\xF3 as utiliz\xE1veis (manuais ou de provider com integra\xE7\xE3o ativa).", schema: { type: "string", enum: ["true", "false"] } }
|
|
4361
4984
|
],
|
|
4362
4985
|
responses: { "200": paginatedResponse("#/components/schemas/PaymentMethod"), ...COMMON_ERRORS }
|
|
@@ -4367,12 +4990,12 @@ var OPENAPI_SPEC = {
|
|
|
4367
4990
|
tags: ["M\xE9todos de pagamento"],
|
|
4368
4991
|
summary: "Listar m\xE9todos de pagamento a fornecedor (AP)",
|
|
4369
4992
|
operationId: "listPaymentMethodsAp",
|
|
4370
|
-
description: "Formas de pagamento usadas em payouts (contas a pagar).",
|
|
4993
|
+
description: "Formas de pagamento usadas em payouts (contas a pagar) e no `payment_method_id` de POST /v1/purchase-invoices/{id}/pay.",
|
|
4371
4994
|
security: [{ ApiKeyAuth: ["payouts:read"] }, { ApiKeyAuth: ["payouts:create"] }],
|
|
4372
4995
|
parameters: [
|
|
4373
4996
|
...PAGINATION_PARAMS,
|
|
4374
4997
|
{ name: "active", in: "query", schema: { type: "string", enum: ["true", "false"] } },
|
|
4375
|
-
{ name: "provider", in: "query", schema: { type: "string", enum: ["inter", "c6bank"] } }
|
|
4998
|
+
{ name: "provider", in: "query", schema: { type: "string", enum: ["inter", "c6bank", "cora"] } }
|
|
4376
4999
|
],
|
|
4377
5000
|
responses: { "200": paginatedResponse("#/components/schemas/PaymentMethod"), ...COMMON_ERRORS }
|
|
4378
5001
|
}
|
|
@@ -4481,7 +5104,8 @@ var API_MODULES = [
|
|
|
4481
5104
|
{ key: "read", label: "Listar e visualizar", description: "Consultar contas a pagar" },
|
|
4482
5105
|
{ key: "create", label: "Criar", description: "Lan\xE7ar contas a pagar" },
|
|
4483
5106
|
{ key: "cancel", label: "Cancelar", description: "Cancelar contas a pagar" },
|
|
4484
|
-
{ key: "delete", label: "Excluir", description: "Excluir contas a pagar definitivamente" }
|
|
5107
|
+
{ key: "delete", label: "Excluir", description: "Excluir contas a pagar definitivamente" },
|
|
5108
|
+
{ key: "settle", label: "Registrar pagamento", description: "Dar baixa manual numa parcela (conta, forma, data, parcial, juros/multa/desconto) \u2014 n\xE3o move dinheiro no banco" }
|
|
4485
5109
|
]
|
|
4486
5110
|
},
|
|
4487
5111
|
{
|
|
@@ -4527,6 +5151,17 @@ var API_MODULES = [
|
|
|
4527
5151
|
{ key: "delete", label: "Excluir regra", description: "Remover regras de split" }
|
|
4528
5152
|
]
|
|
4529
5153
|
},
|
|
5154
|
+
{
|
|
5155
|
+
key: "parcerias",
|
|
5156
|
+
label: "Parcerias",
|
|
5157
|
+
permissions: [
|
|
5158
|
+
{ key: "list", label: "Listar e visualizar", description: "Consultar parcerias, saldos, livro de lan\xE7amentos, v\xEDnculos e presta\xE7\xE3o de contas" },
|
|
5159
|
+
{ key: "create", label: "Criar e lan\xE7ar", description: "Criar parcerias e lan\xE7ar receita, despesa ou transfer\xEAncia na divis\xE3o padr\xE3o" },
|
|
5160
|
+
{ key: "update", label: "Gerir", description: "Vincular itens, ajustar, estornar, al\xEDquota \xE0 m\xE3o, divis\xE3o pr\xF3pria e notas das retiradas" },
|
|
5161
|
+
{ key: "retirar", label: "Registrar retirada", description: "Registrar retirada de participante (vira despesa paga na empresa)" },
|
|
5162
|
+
{ key: "delete", label: "Encerrar", description: "Encerrar parcerias" }
|
|
5163
|
+
]
|
|
5164
|
+
},
|
|
4530
5165
|
{
|
|
4531
5166
|
key: "inbox",
|
|
4532
5167
|
label: "Caixa de Entrada",
|
|
@@ -5028,7 +5663,7 @@ function buildWhoamiTool(api) {
|
|
|
5028
5663
|
// src/branding.ts
|
|
5029
5664
|
var MCP_SERVER_NAME = "comando-one";
|
|
5030
5665
|
var MCP_SERVER_TITLE = "Comando1";
|
|
5031
|
-
var MCP_SERVER_VERSION = "0.
|
|
5666
|
+
var MCP_SERVER_VERSION = "0.15.0";
|
|
5032
5667
|
var MCP_SERVER_DESCRIPTION = "ERP das empresas de servi\xE7o brasileiras: clientes, propostas, contratos, faturas, cobran\xE7as Pix e boleto, NFS-e, contas a pagar e financeiro.";
|
|
5033
5668
|
var MCP_SERVER_WEBSITE = "https://comando.one";
|
|
5034
5669
|
var MCP_SERVER_ICONS = [
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@comando.one/mcp-server",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.15.0",
|
|
4
4
|
"description": "Servidor MCP (Model Context Protocol) para a API pública do Comando1 — opere seu ERP por linguagem natural.",
|
|
5
5
|
"author": "Orbital Tecnologia e Desenvolvimento LTDA <contato@comando.one> (https://orbitaldev.com.br)",
|
|
6
6
|
"homepage": "https://comando.one",
|