update_goal
Atualizar meta financeira.
Metas e contribuições · Editar ou configurar · 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. |
id | Sim | texto | ID do registro devolvido por get_goals. |
currency | Sim | "BRL" / "USD" / "EUR" / "GBP" / "ARS" / "AUD" / "BHD" / "CAD" / "CHF" / "CLP" / "JPY" / "KWD" | Moeda da operação. Valores de moedas diferentes permanecem separados. |
name | Sim | texto | Nome de exibição do registro. |
personId | Não | texto | Titular declarado. Obtenha seu ID em caderninho_status. |
targetDate | Não | texto ou null | Prazo da meta; null representa ausência de data definida. Padrão: null. |
targetMinor | Sim | texto | Valor-alvo da meta, em unidades menores da sua moeda. |
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": "update_goal",
"arguments": {
"confirmed": true,
"idempotency_key": "docs:update_goal:01",
"spaceId": "personal",
"id": "id-exemplo",
"currency": "BRL",
"name": "Mercado de exemplo",
"targetMinor": "10000"
}
}
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
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"currency": {
"type": "string",
"enum": [
"BRL",
"USD",
"EUR",
"GBP",
"ARS",
"AUD",
"BHD",
"CAD",
"CHF",
"CLP",
"JPY",
"KWD"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"personId": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"targetDate": {
"default": null,
"anyOf": [
{
"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])))$"
},
{
"type": "null"
}
]
},
"targetMinor": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,29})$"
}
},
"required": [
"confirmed",
"idempotency_key",
"spaceId",
"id",
"currency",
"name",
"targetMinor"
],
"additionalProperties": false
}
Voltar para Metas e contribuições · Confirmações e contratos