create_manual_installment
Criar plano e recorrência de parcelas sem gerar transações futuras.
Cartões, faturas e parcelas · Criar · Escrita local
Efeito da chamada
Esta ferramenta altera dados locais da instalação. Confirme a ação e o espaço com o proprietário antes de enviar confirmed: true e uma chave de idempotência. Ela não altera registros nem executa pagamentos no banco.
Parâmetros
| Campo | Obrigatório | Tipo | Uso |
|---|---|---|---|
confirmed | Sim | true | Deve ser true somente depois da confirmação explícita do proprietário. |
idempotency_key | Sim | texto | Chave única para esta solicitação. Reutilize apenas para repetir exatamente a mesma operação. |
spaceId | Sim | texto | Espaço da instalação. Consulte get_spaces; o espaço inicial é personal. |
accountId | Sim | texto | ID de conta devolvido por get_accounts. |
amountMinor | Sim | texto | Valor exato em unidades menores, como string. Em BRL, "10000" significa R$ 100,00. |
categoryId | Não | texto ou null | ID de categoria devolvido por get_categories no mesmo espaço. Padrão: null. |
current | Sim | inteiro | Número da parcela corrente no plano manual. Máximo: 600. Mínimo: 1. |
name | Sim | texto | Nome de exibição do registro. |
startDate | Sim | texto | Primeiro dia da recorrência, em AAAA-MM-DD. |
total | Sim | inteiro | Quantidade total de parcelas do plano manual. Máximo: 600. Mínimo: 1. |
Filtros compostos e limites estão no schema completo. Campos não listados são recusados.
Exemplo de chamada
Substitua os IDs fictícios pelos da sua instalação, obtidos nas consultas indicadas nos parâmetros.
{
"name": "create_manual_installment",
"arguments": {
"confirmed": true,
"idempotency_key": "docs:create_manual_installment:01",
"spaceId": "personal",
"accountId": "accountId-exemplo",
"amountMinor": "10000",
"current": 1,
"name": "Mercado de exemplo",
"startDate": "2026-10-01",
"total": 12
}
}
Interpretar o resultado
Confira o resultado da chamada antes de dar a alteração como concluída. Se a rede falhar, repita somente os mesmos argumentos com a mesma chave. Atualize a leitura se a revisão estiver obsoleta antes de confirmar outra operação.
O registro desta ferramenta não declara outputSchema. Consulte as regras de resposta no guia de contratos.
Contrato completo
Ver JSON Schema de entrada
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"confirmed": {
"type": "boolean",
"const": true
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"spaceId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"accountId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"amountMinor": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,29})$"
},
"categoryId": {
"default": null,
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 160
},
{
"type": "null"
}
]
},
"current": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"startDate": {
"type": "string",
"format": "date",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
},
"total": {
"type": "integer",
"minimum": 1,
"maximum": 600
}
},
"required": [
"confirmed",
"idempotency_key",
"spaceId",
"accountId",
"amountMinor",
"current",
"name",
"startDate",
"total"
],
"additionalProperties": false
}
Voltar para Cartões, faturas e parcelas · Confirmações e contratos