Gestão Cultural Pro · Desenvolvedores

API Gestão Cultural Pro

Conecte ERPs, sistemas financeiros e ferramentas de gestão de tarefas ao Módulo Financeiro e aos Espaços de Trabalho, com o rigor que a gestão de projetos culturais exige.

PremiumREST · JSONWebhooks assinadosIdempotênciaFuso de BrasíliaPT-BR
Basehttps://gestaoculturalpro.com.br/api/v1

1Visão geral

A API dá a sistemas parceiros acesso seguro, granular e auditável aos dados da sua Instituição/Empresa no GCP. Ela foi desenhada a partir do dia a dia de produtoras, institutos e coletivos: cada lançamento pode ser rateado por projeto e rubrica, cada cartão pode pertencer a um projeto, e tudo o que entra pela API segue as mesmas regras do aplicativo.

R$

Financeiro completo

Contas e saldos, contas a pagar e a receber, baixas, transferências, contatos, plano de contas, planejamento e relatórios.

▦

Espaços de Trabalho

Quadros, listas, cartões com checklists e campos personalizados, tarefas, canais e documentos.

⚡

Tempo real

Webhooks com assinatura HMAC-SHA256 e feed de eventos para sincronização incremental confiável.

🔒

Segurança

Chaves com permissões por módulo, validade, renovação sem interrupção, limite de requisições e auditoria.

↺

Sem duplicidade

Idempotency-Key em criações e controle de versão (If-Match) em alterações concorrentes.

🇧🇷

Feita para o Brasil

Valores em BRL (reais e centavos), CPF/CNPJ validados e datas no calendário de Brasília.

2Início rápido

  1. Gere a chave. Um Administrador da Instituição/Empresa acessa Gestão Global → Instituição/Empresa → API Gestão Cultural Pro → Gerar chave de API, escolhe os módulos e o tipo de integração.
  2. Guarde em segredo. A chave aparece uma única vez. Armazene em um cofre de segredos ou em variável de ambiente (ex.: GCP_API_KEY) do seu servidor.
  3. Faça a primeira chamada. GET /v1/ping confirma a instituição, as permissões e a validade da chave.
Primeira chamada
cURLcurl https://gestaoculturalpro.com.br/api/v1/ping \
  -H "Authorization: Bearer $GCP_API_KEY"
Node.js// Node.js 18+ (fetch nativo)
const res = await fetch("https://gestaoculturalpro.com.br/api/v1/ping", {
  headers: { Authorization: `Bearer ${process.env.GCP_API_KEY}` },
});
console.log(res.status, await res.json());
Pythonimport os, requests

r = requests.get(
    "https://gestaoculturalpro.com.br/api/v1/ping",
    headers={"Authorization": f"Bearer {os.environ['GCP_API_KEY']}"},
    timeout=30,
)
print(r.status_code, r.json())
PHP<?php
$ch = curl_init("https://gestaoculturalpro.com.br/api/v1/ping");
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GCP_API_KEY")],
  CURLOPT_RETURNTRANSFER => true,
]);
$body = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE);
C#using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("GCP_API_KEY"));
var res = await http.GetAsync("https://gestaoculturalpro.com.br/api/v1/ping");
Console.WriteLine(await res.Content.ReadAsStringAsync());
Resposta 200
{
  "object": "ping",
  "ok": true,
  "api_version": "2026-11-01",
  "server_time": "2026-11-06T15:04:05.000Z",
  "timezone": "America/Sao_Paulo",
  "institution": {
    "id": "inst_8Hk",
    "name": "Instituto Exemplo"
  },
  "key": {
    "id": "3fa2c1d09b7e4a55",
    "name": "ERP Parceiro",
    "scopes": [
      "financial:read",
      "financial:write",
      "webhooks:manage"
    ],
    "expires_at": "2027-02-04T15:00:00.000Z"
  },
  "rate_limit_per_minute": 120,
  "request_id": "req_Q2m8XvLrT0aZk4Yp1nBc"
}

3Escolha o tipo de integração

O administrador escolhe, em linguagem simples, como os sistemas vão conversar. Cada opção corresponde a um conjunto de permissões, que também pode ser personalizado item por item.

👁

Somente consulta

GCP → parceiro (o parceiro busca)
Para quem
BI, painéis gerenciais, auditoria, conferência contábil
Como funciona
O parceiro lê os dados quando precisar, com filtros por período, conta, projeto e status. Para manter uma cópia atualizada sem reler tudo, use o feed de eventos (GET /v1/events).
Permissões
financial:readworkspace:read
Guia
Ver receita passo a passo →
⬅

Só um lado: enviar ao GCP

Parceiro → GCP
Para quem
ERPs e sistemas de compras que geram contas a pagar e a receber
Como funciona
O parceiro cria contatos, lançamentos e transferências, registra baixas e anexa documentos. Use Idempotency-Key em toda criação para nunca duplicar registros.
Permissões
financial:readfinancial:write
Guia
Ver receita passo a passo →
➡

Só um lado: o GCP avisa

GCP → parceiro (o GCP envia)
Para quem
ERPs que precisam saber o que foi pago ou alterado no GCP
Como funciona
O parceiro cadastra um webhook e recebe cada alteração em segundos, assinada com HMAC-SHA256. Em caso de indisponibilidade, as entregas são repetidas automaticamente.
Permissões
financial:readwebhooks:manage
Guia
Ver receita passo a passo →
⇄

Os dois lados

Parceiro ⇄ GCP
Para quem
Integração financeira completa com ERP; gestão de tarefas sincronizada
Como funciona
Combina envio e avisos. Cada evento informa a origem (app ou api, com a chave), o que evita laços: ignore os eventos gerados pela sua própria chave.
Permissões
financial:readfinancial:writeworkspace:readworkspace:writewebhooks:manage
Guia
Ver receita passo a passo →
★

Acesso completo

Parceiro ⇄ GCP, com remoção
Para quem
Parceiros de total confiança, migrações e saneamento de dados
Como funciona
Inclui remoções, sempre com salvaguardas: lançamentos pagos ou conciliados, contatos com lançamentos e contas com movimentação não são apagados.
Permissões
financial:readfinancial:writefinancial:deleteworkspace:readworkspace:writeworkspace:deletewebhooks:manage
Guia
Ver receita passo a passo →

4Autenticação e chaves

Envie a chave em todas as requisições, no cabeçalho Authorization. O cabeçalho X-API-Key também é aceito.

Cabeçalho
Authorization: Bearer gcp_live_3fa2c1d09b7e4a55_Xk7…(48 caracteres)
CaracterísticaComo funciona
Formatogcp_live_<id de 16 caracteres>_<segredo de 48 caracteres>. O id identifica a chave nos registros de auditoria; o segredo nunca é armazenado (guardamos apenas o SHA-256).
Quem geraSomente Administradores da Instituição/Empresa. Outros perfis não acessam a área de chaves.
Escopo de dadosCada chave acessa exclusivamente a instituição em que foi gerada.
Validade30, 90 (recomendado), 180 ou 365 dias, ou sem validade.
RenovaçãoGera um novo segredo. O anterior pode continuar válido por 1 hora, 24 horas ou 7 dias, para a troca sem interrupção.
DesvinculaçãoRevoga a chave na hora e pausa os webhooks criados por ela.
Autoria das açõesAlterações são registradas em nome do administrador que gerou a chave, com a indicação “via API (nome do aplicativo)”. Se esse usuário for desativado, a chave para de funcionar (403 owner_inactive).

Uso exclusivo servidor a servidor. Nunca coloque a chave em aplicativos móveis, páginas web ou repositórios de código. A API não envia cabeçalhos CORS, o que impede o uso direto por navegadores.

5Permissões (escopos)

EscopoNome no painelPermite
financial:readFinanceiro · ConsultarContas, saldos, extratos, lançamentos, contatos, planejamento, categorias, projetos, relatórios e eventos financeiros.
financial:writeFinanceiro · Criar e editarLançamentos, baixas e reaberturas, transferências, contas, contatos e planejamento.
financial:deleteFinanceiro · RemoverLançamentos em aberto, contatos sem lançamentos, planejamento em rascunho e contas sem movimentação.
workspace:readEspaços · ConsultarQuadros, listas, cartões, comentários, tarefas, canais, documentos, membros, projetos e eventos de Espaços.
workspace:writeEspaços · Criar e editarQuadros, listas, cartões, comentários, tarefas e mensagens nos Canais da Equipe.
workspace:deleteEspaços · RemoverArquivar e remover cartões e listas; remover tarefas.
webhooks:manageTempo realCadastrar, alterar, testar e remover webhooks; receber eventos dos módulos permitidos.

Criar, editar ou remover em um módulo inclui automaticamente a consulta desse módulo. Rotas sem a permissão necessária respondem 403 insufficient_scope, com a lista em error.required_scopes.

6Convenções

JSON e nomes

Requisições e respostas em JSON UTF-8, com campos em snake_case. Envie Content-Type: application/json. Parâmetros desconhecidos são recusados (400), para que erros de digitação não passem despercebidos.

Datas e fuso

Datas no formato AAAA-MM-DD, sempre no calendário de Brasília (America/Sao_Paulo). Data e hora em ISO 8601 (UTC). Em cartões, uma data sem hora é gravada às 12:00 de Brasília.

Valores

Moeda BRL. Envie amount (reais, até 2 casas) ou amount_cents (inteiro). As respostas trazem os dois. Prefira centavos para evitar arredondamentos.

Enumerações

Valores normalizados em inglês (income, paid…), compatíveis com qualquer ERP. Os campos raw_* trazem o termo original em português (Receita, Pago…).

Paginação por cursor

Listas retornam { object: "list", data, has_more, next_cursor }. Repita a chamada com cursor=next_cursor até has_more = false. limit: 1 a 200 (padrão 50). Em buscas com filtros calculados, uma página pode vir menor e ainda assim ter has_more = true.

Concorrência (If-Match)

Leituras individuais trazem etag. Envie If-Match: <etag> no PATCH/DELETE: se a equipe alterou o registro no aplicativo depois da sua leitura, a API responde 412 em vez de sobrescrever.

Idempotência

Envie Idempotency-Key (8 a 255 caracteres, ex.: UUID ou id do seu pedido) em todo POST. Repetições em até 24 h devolvem a mesma resposta, com Idempotent-Replayed: true, sem criar duplicatas.

Limites

120 requisições por minuto por chave. Cabeçalhos RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset; ao exceder, 429 com Retry-After. Corpo até 1 MB.

Percorrendo todas as páginas
Node.jsasync function* todosOsLancamentos(filtros) {
  let cursor;
  do {
    const qs = new URLSearchParams({ ...filtros, limit: "200", ...(cursor && { cursor }) });
    const res = await fetch(`https://gestaoculturalpro.com.br/api/v1/financial/transactions?${qs}`, { headers });
    const page = await res.json();
    yield* page.data;
    cursor = page.has_more ? page.next_cursor : null;
  } while (cursor);
}

for await (const t of todosOsLancamentos({ date_from: "2026-11-01", date_to: "2026-11-30" })) {
  console.log(t.date, t.description, t.amount);
}
Pythondef todos_os_lancamentos(**filtros):
    cursor = None
    while True:
        params = {**filtros, "limit": 200, **({"cursor": cursor} if cursor else {})}
        page = requests.get(f"https://gestaoculturalpro.com.br/api/v1/financial/transactions",
                            headers=HEADERS, params=params, timeout=30).json()
        yield from page["data"]
        if not page["has_more"]:
            break
        cursor = page["next_cursor"]

Cabeçalhos de toda resposta: X-Request-Id (informe ao suporte), GCP-Api-Version (2026-11-01), Cache-Control: no-store.

Versionamento: o prefixo /v1 é estável. Novos campos e novas rotas podem ser adicionados sem aviso; seu código deve ignorar campos que não conhece. Mudanças incompatíveis só ocorrem em uma nova versão (/v2), anunciada com antecedência.

7Erros

Erros seguem sempre o mesmo formato, com mensagem em português pronta para exibir ao usuário final.

Resposta 409
{
  "error": {
    "type": "conflict",
    "code": "contact_exists",
    "message": "Já existe um contato com este CPF/CNPJ nesta instituição.",
    "existing_id": "ct_17",
    "request_id": "req_Hn3…",
    "doc_url": "https://gestaoculturalpro.com.br/developers/#erros"
  }
}
HTTPtypeQuando ocorre
400invalid_requestParâmetro ausente, inválido ou desconhecido (veja error.param)
401authenticationChave ausente, inválida, revogada ou expirada
403permissionEscopo insuficiente (error.required_scopes) ou usuário que gerou a chave desativado
404not_foundRegistro inexistente ou de outra instituição
405invalid_requestMétodo não permitido (cabeçalho Allow)
409conflictRegra de negócio: registro conciliado, duplicado (existing_id), com vínculos…
412preconditionIf-Match não confere: o registro mudou depois da sua leitura
413 · 415invalid_requestCorpo acima de 1 MB · Content-Type diferente de JSON
422invalid_request / idempotencyVínculo inexistente (conta, contato, projeto, membro, etiqueta) ou Idempotency-Key reutilizada
429rate_limitLimite por minuto atingido (aguarde Retry-After segundos)
500serverFalha inesperada — repita com backoff e informe o request_id

Códigos (error.code)

parameter_missingunknown_parameterinvalid_typeinvalid_enuminvalid_dateinvalid_numberinvalid_idinvalid_cursorinvalid_documentallocations_mismatchrelated_not_foundinsufficient_scopeinvalid_api_keyrevoked_api_keyexpired_api_keyowner_inactivetransaction_reconciledtransaction_settledtransaction_linkedtransfer_immutablealready_settledfuture_settlementcontact_existscontact_in_useaccount_in_useplanning_processedcard_not_archivedlist_not_emptyunknown_labelunknown_memberunknown_custom_fieldversion_conflictidempotency_key_reusedidempotency_in_progressrate_limit_exceededwebhook_limitprivate_urlinsecure_url

Quando repetir? Repita apenas 429 (após Retry-After) e 5xx, com espera exponencial (1 s, 2 s, 4 s…). Erros 4xx indicam algo a corrigir na requisição. Com Idempotency-Key, repetir um POST é sempre seguro.

8Módulo Financeiro

Tudo o que a equipe financeira faz no GCP: contas bancárias, contas a pagar e a receber, transferências, baixas, contatos, plano de contas, planejamento e relatórios. Os registros são gravados exatamente como o aplicativo os grava, preservando saldos, conciliação, rateios por projeto e o histórico de alterações.

Criando uma despesa (com Idempotency-Key)
cURLcurl -X POST https://gestaoculturalpro.com.br/api/v1/financial/transactions \
  -H "Authorization: Bearer $GCP_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2a9e-erp-pedido-48213" \
  -d '{
    "type": "expense",
    "amount": 3500.00,
    "date": "2026-11-20",
    "account_id": "acc_9f2",
    "contact_id": "ct_17",
    "description": "Sonorização — Festival de Música",
    "allocations": [{ "project_id": "prj_fest", "rubric_id": "rub_som", "amount": 3500.00 }]
  }'
Node.jsconst res = await fetch("https://gestaoculturalpro.com.br/api/v1/financial/transactions", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.GCP_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": `erp-pedido-${pedido.id}`, // mesma chave = sem duplicidade
  },
  body: JSON.stringify({
    type: "expense",
    amount_cents: 350000,
    date: "2026-11-20",
    account_id: "acc_9f2",
    description: "Sonorização — Festival de Música",
  }),
});
if (!res.ok) throw new Error((await res.json()).error.message);
Pythonr = requests.post(
    "https://gestaoculturalpro.com.br/api/v1/financial/transactions",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Idempotency-Key": f"erp-pedido-{pedido_id}",
    },
    json={
        "type": "expense",
        "amount": 3500.00,
        "date": "2026-11-20",
        "account_id": "acc_9f2",
        "description": "Sonorização — Festival de Música",
    },
    timeout=30,
)
r.raise_for_status()
transacao = r.json()
PHP$payload = json_encode([
  "type" => "expense",
  "amount" => 3500.00,
  "date" => "2026-11-20",
  "account_id" => "acc_9f2",
  "description" => "Sonorização — Festival de Música",
]);
$ch = curl_init("https://gestaoculturalpro.com.br/api/v1/financial/transactions");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => $payload,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer " . getenv("GCP_API_KEY"),
    "Content-Type: application/json",
    "Idempotency-Key: erp-pedido-" . $pedidoId,
  ],
]);
$transacao = json_decode(curl_exec($ch), true);

Contas bancárias account

Contas correntes, poupanças, investimentos e caixas. O saldo é calculado em tempo real a partir dos lançamentos, com as mesmas regras do aplicativo.

Campos principais do objeto
idstringIdentificador da conta
namestringNome da conta
bank_name / bank_codestringBanco e código (ex.: 001)
agency / account_numberstringAgência e número
typeenumchecking · savings · investment · cash
initial_balancenumberSaldo inicial em reais
activebooleanConta ativa
project_account / project_idboolean / stringConta exclusiva de projeto
balance.reconcilednumberSaldo conciliado com o extrato bancário (até hoje)
balance.settlednumberSaldo de tudo que foi pago ou recebido até hoje
balance.projectednumberSaldo considerando também os lançamentos em aberto
balance.pending_income / pending_expensenumberValores a receber e a pagar
GET/v1/financial/accountsfinancial:read

Listar contas

Parâmetros de consulta

ParâmetroTipoDescrição
activebooleantrue ou false
includestringbalance: inclui os saldos de cada conta
limit / cursorPaginação
GET/v1/financial/accounts/{id}financial:read

Consultar conta com saldos

POST/v1/financial/accountsfinancial:write

Criar conta

Corpo (JSON)

ParâmetroTipoDescrição
name obrigatóriostringAté 120 caracteres
typeenumchecking (padrão) · savings · investment · cash
bank_name, bank_code, agency, account_number, pix_keystringDados bancários
initial_balancenumberPode ser negativo
project_idstringVincula a conta a um projeto
colorstring#RRGGBB
activebooleanPadrão: true
PATCH/v1/financial/accounts/{id}financial:write

Alterar conta

Mesmos campos da criação, exceto type e project_id.

DELETE/v1/financial/accounts/{id}financial:delete

Remover conta sem movimentação

Contas com lançamentos retornam 409 account_in_use; desative com {"active": false}.

GET/v1/financial/accounts/{id}/statementfinancial:read

Extrato com saldo acumulado

Parâmetros de consulta

ParâmetroTipoDescrição
date_from / date_toAAAA-MM-DDPadrão: mês atual até hoje
statusenumsettled (padrão) · reconciled · all

Exemplo · Extrato do mês

Requisição
GET /v1/financial/accounts/acc_9f2/statement?date_from=2026-11-01&date_to=2026-11-30
Resposta 2xx
{
  "object": "account_statement",
  "account_id": "acc_9f2",
  "date_from": "2026-11-01",
  "date_to": "2026-11-30",
  "status": "settled",
  "opening_balance": 12450,
  "closing_balance": 15980.5,
  "currency": "BRL",
  "entries": [
    {
      "transaction_id": "tx_81a",
      "date": "2026-11-04",
      "description": "Patrocínio — cota ouro",
      "type": "income",
      "amount": 5000,
      "amount_cents": 500000,
      "balance_after": 17450,
      "status": "received",
      "reconciled": true,
      "contact_id": "ct_17",
      "document_number": null,
      "bank_transaction_id": "20261104001"
    }
  ]
}

Lançamentos transaction

Receitas e despesas (contas a receber e a pagar) com rateio por projeto e rubrica orçamentária, documentos fiscais, anexos, baixa e conciliação. Transferências entre contas são criadas em /transfers.

Campos principais do objeto
typeenumincome · expense · transfer
statusenumpending · scheduled · overdue · paid · received · reconciled
settledbooleantrue quando pago, recebido ou conciliado
amount / amount_centsnumber / integerValor em reais e em centavos (BRL)
dateAAAA-MM-DDData do pagamento/recebimento (previsto ou efetivo)
due_date / competence_date / issue_dateAAAA-MM-DDVencimento, competência e emissão do documento
account_id / contact_idstringConta bancária e cliente/fornecedor
allocations[]arrayRateio: project_id, rubric_id, cost_center, amount, cost_type, tags
document_type / document_numberstringEx.: Nota Fiscal · NF 1234
bank_transaction_idstringIdentificador do banco (FITID do OFX) para conciliação
original_amount / settlements[]number / arrayValor original e histórico de baixas com diferença
raw_type / raw_statusstringValores originais em português (Receita, Pago…)
etagstringVersão do registro para If-Match
GET/v1/financial/transactionsfinancial:read

Listar lançamentos

Parâmetros de consulta

ParâmetroTipoDescrição
typeenumincome · expense · transfer
statusenumpending · scheduled · overdue · paid · received · reconciled
settledbooleanSomente baixados (true) ou em aberto (false)
account_id · contact_id · project_idstringFiltros por vínculo
date_from / date_toAAAA-MM-DDPeríodo (ordena por data e inclui total_count)
date_fieldenumdate (padrão) · due_date · competence_date
limit / cursorPaginação
GET/v1/financial/transactions/{id}financial:read

Consultar lançamento (inclui etag)

POST/v1/financial/transactionsfinancial:write

Criar receita ou despesa

Corpo (JSON)

ParâmetroTipoDescrição
type obrigatórioenumincome · expense
amount ou amount_cents obrigatórionumberValor maior que zero, até 2 casas
date obrigatórioAAAA-MM-DDData prevista ou efetiva
account_id obrigatóriostringConta bancária
description obrigatóriostringAté 500 caracteres
statusenumPadrão: pending. paid/received com data futura vira scheduled
contact_idstringCliente ou fornecedor
due_date · competence_date · issue_dateAAAA-MM-DDPadrão de vencimento e competência: date
category · cost_center · payment_methodstringClassificação
document_type · document_number · bank_document_number · bank_transaction_idstringDocumento e banco
allocationsarraySoma igual ao valor (até 50 itens)
attachmentsarrayAté 20 { name, url (https), content_type, document_type }
tags · notesarray · stringEtiquetas e observações
PATCH/v1/financial/transactions/{id}financial:write

Alterar lançamento

Lançamentos conciliados aceitam apenas campos descritivos. Envie If-Match para evitar sobrescrever alterações feitas no aplicativo.

POST/v1/financial/transactions/{id}/settlefinancial:write

Registrar baixa (pagamento ou recebimento)

Corpo (JSON)

ParâmetroTipoDescrição
dateAAAA-MM-DDPadrão: hoje (não pode ser futura)
amountnumberValor efetivo; a diferença fica registrada em settlements
reconciledbooleantrue marca como conciliado com o extrato
bank_transaction_idstringIdentificador do banco
POST/v1/financial/transactions/{id}/reopenfinancial:write

Desfazer baixa

Lançamentos conciliados devem ter a conciliação desfeita no aplicativo.

DELETE/v1/financial/transactions/{id}financial:delete

Excluir lançamento em aberto

Baixados e vinculados a Vendas, Planejamento ou Logística retornam 409. Em transferências, as duas pernas são excluídas.

Exemplo · Despesa com rateio por projeto e rubrica

POST /v1/financial/transactions
{
  "type": "expense",
  "amount": 3500,
  "date": "2026-11-20",
  "due_date": "2026-11-20",
  "account_id": "acc_9f2",
  "contact_id": "ct_17",
  "description": "Sonorização — Festival de Música",
  "document_type": "Nota Fiscal",
  "document_number": "NF 4821",
  "allocations": [
    {
      "project_id": "prj_fest",
      "rubric_id": "rub_som",
      "amount": 3500
    }
  ],
  "tags": [
    "festival"
  ]
}
Resposta 2xx
{
  "id": "tx_7Qm2",
  "object": "transaction",
  "type": "expense",
  "raw_type": "Despesa",
  "status": "pending",
  "raw_status": "Pendente",
  "settled": false,
  "reconciled": false,
  "description": "Sonorização — Festival de Música",
  "amount": 3500,
  "amount_cents": 350000,
  "currency": "BRL",
  "date": "2026-11-20",
  "due_date": "2026-11-20",
  "competence_date": "2026-11-20",
  "account_id": "acc_9f2",
  "contact_id": "ct_17",
  "project_ids": [
    "prj_fest"
  ],
  "allocations": [
    {
      "project_id": "prj_fest",
      "rubric_id": "rub_som",
      "amount": 3500,
      "amount_cents": 350000
    }
  ],
  "etag": "1793548800123.0"
}

Transferências transfer

Movimentação entre duas contas da instituição. Gera dois lançamentos pareados (saída e entrada), exatamente como o aplicativo, e os saldos das duas contas ficam coerentes.

POST/v1/financial/transfersfinancial:write

Criar transferência

Corpo (JSON)

ParâmetroTipoDescrição
from_account_id obrigatóriostringConta de origem
to_account_id obrigatóriostringConta de destino (diferente da origem)
amount ou amount_cents obrigatórionumberValor
date obrigatórioAAAA-MM-DDData
statusenumpending (padrão) · scheduled · paid · reconciled
description · notes · document_number · tagsOpcionais

Contatos (clientes e fornecedores) contact

Pessoas físicas e jurídicas usadas nos lançamentos. CPF e CNPJ são validados pelos dígitos verificadores e não se repetem na instituição.

Campos principais do objeto
kindenumindividual (PF) · company (PJ)
documentstringCPF/CNPJ somente dígitos (document_formatted traz a máscara)
roleenumcustomer · supplier · both
bankobjectbank_name, agency, account, account_type, pix_key, pix_key_type
GET/v1/financial/contactsfinancial:read

Listar ou buscar

Parâmetros de consulta

ParâmetroTipoDescrição
documentstringBusca exata por CPF/CNPJ (com ou sem máscara)
searchstringBusca por nome, sem diferenciar acentos
roleenumcustomer · supplier · both
GET/v1/financial/contacts/{id}financial:read

Consultar contato

POST/v1/financial/contactsfinancial:write

Criar contato

Corpo (JSON)

ParâmetroTipoDescrição
name obrigatóriostringNome ou razão social
documentstringCPF/CNPJ válido; duplicado retorna 409 com existing_id
kind · roleenumDeduzidos do documento quando omitidos
email · phone · address · tags · bankOpcionais
PATCH/v1/financial/contacts/{id}financial:write

Alterar contato

DELETE/v1/financial/contacts/{id}financial:delete

Remover contato sem lançamentos

Plano de contas e listas category

Categorias de receita e despesa (plano de contas da instituição e de cada conta bancária), além dos centros de custo, formas de pagamento e tipos de documento cadastrados.

GET/v1/financial/categoriesfinancial:read

Listar categorias, centros de custo e listas

Planejamento financeiro planning_item

Pré-planejamento de pagamentos e recebimentos por mês. Itens em rascunho podem ser alterados; ao serem enviados para Contas a Pagar/Receber no aplicativo, passam a processed e geram um lançamento.

GET/v1/financial/planningfinancial:read

Listar itens

Parâmetros de consulta

ParâmetroTipoDescrição
monthAAAA-MMMês
statusenumdraft · processed
GET/v1/financial/planning/{id}financial:read

Consultar item

POST/v1/financial/planningfinancial:write

Criar item

Corpo (JSON)

ParâmetroTipoDescrição
beneficiary_name obrigatóriostringFavorecido
description obrigatóriostringDescritivo
amount obrigatórionumberValor
planned_date obrigatórioAAAA-MM-DDData prevista (define o mês)
typeenumexpense (padrão) · income
beneficiary_email · due_date · project_id · account_id · rubric_id · payment_methodOpcionais
PATCH/v1/financial/planning/{id}financial:write

Alterar item em rascunho

Aceita também on_hold (true/false) e hold_comment.

DELETE/v1/financial/planning/{id}financial:delete

Remover item em rascunho

Relatório consolidado financial_summary

Receitas, despesas e resultado do período, agrupados como você precisar. Aplicações e resgates de investimento não entram como resultado (somente rendimentos), como no aplicativo.

GET/v1/financial/summaryfinancial:read

Resumo por período

Parâmetros de consulta

ParâmetroTipoDescrição
date_from / date_to obrigatórioAAAA-MM-DDPeríodo
group_byenummonth (padrão) · category · project · account · cost_center
basisenumcash (data do pagamento, padrão) · competence
statusenumsettled (padrão) · all
account_id · project_idstringFiltros

9Projetos

Projetos culturais são o eixo do GCP: lançamentos são rateados por projeto e rubrica, e quadros e tarefas podem pertencer a um projeto. Disponível com financial:read ou workspace:read (somente leitura).

Projetos e execução orçamentária project

Dados do projeto, orçamento aprovado por rubrica e execução financeira (realizado, pendente e disponível por rubrica), pronto para prestação de contas.

GET/v1/projectsfinancial:read ou workspace:read

Listar projetos

Parâmetros de consulta

ParâmetroTipoDescrição
statusenumplanned · in_progress · finished
GET/v1/projects/{id}financial:read ou workspace:read

Consultar projeto com orçamento (budget[])

GET/v1/projects/{id}/financial-summaryfinancial:read

Execução orçamentária por rubrica

Exemplo · Execução por rubrica

Requisição
GET /v1/projects/prj_fest/financial-summary
Resposta 2xx
{
  "object": "project_financial_summary",
  "project_id": "prj_fest",
  "currency": "BRL",
  "budgeted": 13000,
  "expenses": {
    "realized": 8500,
    "pending": 1500
  },
  "income": {
    "received": 80000,
    "pending": 0
  },
  "execution_percentage": 65.38,
  "rubrics": [
    {
      "rubric_id": "rub_som",
      "code": "1.2",
      "name": "Sonorização",
      "budgeted": 3000,
      "realized": 3000,
      "pending": 0,
      "available": 0
    }
  ]
}

10Espaços de Trabalho

Quadros de Trabalho no estilo kanban, tarefas de produção, Canais da Equipe e Documentos Colaborativos. Alterações feitas pela API aparecem para a equipe em tempo real e ficam no histórico de atividades do cartão com o nome do aplicativo. Quadros vinculados ao Asana continuam sincronizando normalmente.

Membros member

Pessoas ativas da instituição (inclusive as que acessam várias instituições). Use os IDs em members, responsible_ids e assignee_id.

GET/v1/workspace/membersworkspace:read

Listar membros ativos

Quadros e listas board / list

Um quadro reúne listas (fases) e cartões. Ao criar um quadro, as listas A Fazer, Em Andamento e Concluído são criadas automaticamente (default_lists: false desativa).

GET/v1/workspace/boardsworkspace:read

Listar quadros

Parâmetros de consulta

ParâmetroTipoDescrição
project_idstringQuadros de um projeto
GET/v1/workspace/boards/{id}workspace:read

Consultar quadro com listas, etiquetas e campos personalizados

Parâmetros de consulta

ParâmetroTipoDescrição
include_archivedbooleanInclui listas arquivadas
POST/v1/workspace/boardsworkspace:write

Criar quadro

Corpo (JSON)

ParâmetroTipoDescrição
title obrigatóriostringTítulo
description · project_idstringOpcionais
visibilityenumworkspace (padrão) · private · organization
membersarrayIDs de membros
labelsarray{ name, color }
default_listsbooleanPadrão: true
PATCH/v1/workspace/boards/{id}workspace:write

Alterar título, descrição ou etiquetas

GET/v1/workspace/boards/{id}/listsworkspace:read

Listar listas (fases)

POST/v1/workspace/boards/{id}/listsworkspace:write

Criar lista

Corpo (JSON)

ParâmetroTipoDescrição
title obrigatóriostringTítulo
color · positionOpcionais (padrão: ao final)
PATCH/v1/workspace/lists/{id}workspace:write

Renomear, reordenar ou arquivar lista

DELETE/v1/workspace/lists/{id}workspace:delete

Arquivar lista (?permanent=true remove lista vazia)

Cartões card

Tarefas do quadro, com responsáveis, etiquetas, datas, checklists, campos personalizados, dependências (blocked_by) e comentários. Datas sem hora são gravadas às 12:00 de Brasília.

Campos principais do objeto
list_idstringLista (fase) atual
description / description_htmlstringTexto simples e HTML (o HTML recebido é higienizado)
completed / archivedbooleanConcluído e arquivado
start_date / due_dateISO 8601Datas (AAAA-MM-DD também é aceito na entrada)
members / labelsarrayIDs de membros e etiquetas do quadro (pelo nome ou id)
checklists[]array{ title, items: [{ text, completed, assignee_id, due_date }] }
custom_fieldsobject{ id_do_campo: valor } conforme o tipo definido no quadro
blocked_byarrayCartões que bloqueiam este
urlstringLink direto para o cartão no GCP
GET/v1/workspace/cardsworkspace:read

Listar cartões de um quadro

Parâmetros de consulta

ParâmetroTipoDescrição
board_id obrigatóriostringQuadro
list_idstringLista
completed · archivedbooleanPadrão: não arquivados
member_idstringResponsável
due_before / due_afterAAAA-MM-DDVencimento
GET/v1/workspace/cards/{id}workspace:read

Consultar cartão (inclui etag)

POST/v1/workspace/cardsworkspace:write

Criar cartão

Corpo (JSON)

ParâmetroTipoDescrição
board_id obrigatóriostringQuadro
title obrigatóriostringTítulo
list_idstringPadrão: primeira lista ativa
description ou description_htmlstringTexto ou HTML
start_date · due_datedataAAAA-MM-DD ou ISO 8601
members · labels · checklists · custom_fields · blocked_byVer campos acima
position · completed · estimated_minutes · locationOpcionais
PATCH/v1/workspace/cards/{id}workspace:write

Alterar, mover (list_id), concluir ou arquivar

Envie null em start_date/due_date para limpar a data. custom_fields é mesclado; null remove um campo.

DELETE/v1/workspace/cards/{id}workspace:delete

Arquivar cartão (?permanent=true remove definitivamente um cartão já arquivado)

GET/v1/workspace/cards/{id}/commentsworkspace:read

Listar comentários

POST/v1/workspace/cards/{id}/commentsworkspace:write

Comentar

Corpo (JSON)

ParâmetroTipoDescrição
text obrigatóriostringAté 5.000 caracteres

Exemplo · Criar cartão com checklist e campo personalizado

POST /v1/workspace/cards
{
  "board_id": "brd_31",
  "list_id": "lst_todo",
  "title": "Contratar sonorização",
  "description": "Cotar com três fornecedores.",
  "due_date": "2026-11-25",
  "members": [
    "usr_ana"
  ],
  "labels": [
    "Urgente"
  ],
  "checklists": [
    {
      "title": "Etapas",
      "items": [
        {
          "text": "Cotar"
        },
        {
          "text": "Fechar contrato"
        }
      ]
    }
  ],
  "custom_fields": {
    "cf_valor": 3500
  }
}
Resposta 2xx
{
  "id": "crd_9Ka",
  "object": "card",
  "board_id": "brd_31",
  "list_id": "lst_todo",
  "title": "Contratar sonorização",
  "completed": false,
  "archived": false,
  "due_date": "2026-11-25T15:00:00.000Z",
  "members": [
    "usr_ana"
  ],
  "labels": [
    {
      "id": "lbl_1",
      "name": "Urgente",
      "color": "#ef4444"
    }
  ],
  "url": "https://gestaoculturalpro.com.br/app/quadro/brd_31?card=crd_9Ka"
}

Tarefas de produção task

Eventos, etapas de projeto e ações de comunicação da Produção, com responsáveis, prioridade, local e checklist.

Campos principais do objeto
kindenumevent · project · communication
priorityenumlow · medium · high
statusenumsuggested · in_progress · completed · cancelled
start_date / end_datestringAAAA-MM-DD ou AAAA-MM-DDTHH:mm (horário de Brasília)
GET/v1/workspace/tasksworkspace:read

Listar tarefas

Parâmetros de consulta

ParâmetroTipoDescrição
status · kind · project_idFiltros
date_from / date_toAAAA-MM-DDTarefas que ocorrem no período
GET/v1/workspace/tasks/{id}workspace:read

Consultar tarefa

POST/v1/workspace/tasksworkspace:write

Criar tarefa

Corpo (JSON)

ParâmetroTipoDescrição
name obrigatóriostringNome
start_date obrigatóriostringInício
end_datestringPadrão: início
kind · priority · status · description · location · address · responsible_ids · project_id · color · checklistOpcionais
PATCH/v1/workspace/tasks/{id}workspace:write

Alterar tarefa

DELETE/v1/workspace/tasks/{id}workspace:delete

Remover tarefa (tarefas com Logística: use status cancelled)

Canais da Equipe e documentos channel / message / doc

Publique avisos automáticos nos Canais da Equipe (ex.: "pagamento confirmado no ERP"). Canais privados só ficam visíveis se o administrador que gerou a chave for membro. Documentos colaborativos: lista com metadados e link.

GET/v1/workspace/channelsworkspace:read

Listar canais

GET/v1/workspace/channels/{id}/messagesworkspace:read

Mensagens recentes (mais novas primeiro)

POST/v1/workspace/channels/{id}/messagesworkspace:write

Publicar mensagem

Corpo (JSON)

ParâmetroTipoDescrição
text obrigatóriostringAté 4.000 caracteres
GET/v1/workspace/docsworkspace:read

Listar documentos colaborativos

11Webhooks e eventos

Toda alteração nos módulos integrados (feita no aplicativo ou pela API) vira um evento. Você pode recebê-los por webhook, em tempo real, ou buscá-los pelo feed GET /v1/events. Os dois caminhos trazem o mesmo conteúdo.

Cadastrando um webhook

POST /v1/webhooks
{
  "url": "https://erp.parceiro.com.br/webhooks/gcp",
  "events": [
    "transaction.created",
    "transaction.settled",
    "transaction.updated"
  ],
  "description": "Sincronização financeira"
}

A resposta traz o secret (whsec_…), exibido somente nesta vez. Use ["*"] para receber todos os eventos permitidos pelas permissões da chave. Requisitos: HTTPS, até 10 webhooks por instituição, sem endereços internos ou privados e sem redirecionamentos.

Catálogo de eventos

EventoQuando
transaction.createdLançamento criado
transaction.updatedLançamento alterado
transaction.settledPago, recebido ou conciliado
transaction.reopenedBaixa desfeita
transaction.deletedLançamento excluído
account.created · account.updated · account.deletedContas bancárias
contact.created · contact.updated · contact.deletedClientes e fornecedores
planning.created · planning.updated · planning.deletedPlanejamento
board.created · board.updated · board.deletedQuadros
list.created · list.updated · list.deletedListas
card.created · card.updated · card.deletedCartões
card.movedCartão mudou de lista
card.completedCartão concluído
card.archivedCartão arquivado
task.created · task.updated · task.deletedTarefas

Uma baixa gera dois eventos: transaction.settled e transaction.updated. Eventos financeiros exigem financial:read; de Espaços, workspace:read.

Formato do evento

POST na sua URL
{
  "id": "evt_17935488001230_9c1e4b7a2d3f8e61",
  "object": "event",
  "type": "transaction.settled",
  "api_version": "2026-11-01",
  "created_at": "2026-11-20T17:32:08.123Z",
  "origin": {
    "type": "app"
  },
  "data": {
    "object": {
      "id": "tx_7Qm2",
      "object": "transaction",
      "type": "expense",
      "status": "paid",
      "amount": 3500,
      "date": "2026-11-20",
      "account_id": "acc_9f2"
    },
    "changed_fields": [
      "status",
      "date"
    ]
  }
}
CabeçalhoConteúdo
GCP-Signaturet=<timestamp>,v1=<HMAC-SHA256 hex de "t.corpo" com o secret>
GCP-Event-Id · GCP-Event-TypeIdentificador e tipo do evento (use o id para descartar repetições)
GCP-Delivery-IdIdentificador da tentativa de entrega

Origem e prevenção de laços

origin.type é app quando a alteração veio da equipe no GCP e api quando veio de uma integração, com key_id e request_id. Em integrações bidirecionais, ignore os eventos cuja origin.key_id seja a sua própria chave: assim, o que você enviou não volta como alteração.

Verificando a assinatura

Validação obrigatória no seu endpoint
Node.jsimport crypto from "node:crypto";
import express from "express";

const app = express();
// Use o corpo BRUTO: a assinatura é calculada sobre os bytes recebidos
app.post("/webhooks/gcp", express.raw({ type: "application/json" }), (req, res) => {
  const header = req.get("GCP-Signature") || "";          // t=1793548800,v1=ab12…
  const { t, v1 } = Object.fromEntries(header.split(",").map(p => p.split("=")));
  const esperado = crypto.createHmac("sha256", process.env.GCP_WEBHOOK_SECRET)
    .update(`${t}.${req.body}`).digest("hex");
  const valido = v1 && crypto.timingSafeEqual(Buffer.from(v1), Buffer.from(esperado));
  const recente = Math.abs(Date.now() / 1000 - Number(t)) < 300; // 5 minutos
  if (!valido || !recente) return res.sendStatus(400);

  const evento = JSON.parse(req.body);
  if (evento.origin.type === "api" && evento.origin.key_id === MINHA_CHAVE_ID) return res.sendStatus(200); // evita laço
  fila.publicar(evento);     // processe de forma assíncrona
  res.sendStatus(200);      // responda em até 10 segundos
});
Pythonimport hmac, hashlib, time, json
from flask import Flask, request, abort

app = Flask(__name__)

@app.post("/webhooks/gcp")
def gcp_webhook():
    partes = dict(p.split("=", 1) for p in request.headers.get("GCP-Signature", "").split(","))
    corpo = request.get_data()  # bytes brutos
    esperado = hmac.new(SECRET.encode(), f"{partes['t']}.".encode() + corpo, hashlib.sha256).hexdigest()
    if not hmac.compare_digest(esperado, partes.get("v1", "")) or abs(time.time() - int(partes["t"])) > 300:
        abort(400)
    evento = json.loads(corpo)
    processar_em_segundo_plano(evento)
    return "", 200
PHP<?php
$corpo = file_get_contents("php://input");
parse_str(str_replace(",", "&", $_SERVER["HTTP_GCP_SIGNATURE"] ?? ""), $sig);
$esperado = hash_hmac("sha256", $sig["t"] . "." . $corpo, getenv("GCP_WEBHOOK_SECRET"));
if (!hash_equals($esperado, $sig["v1"] ?? "") || abs(time() - (int)$sig["t"]) > 300) {
  http_response_code(400); exit;
}
$evento = json_decode($corpo, true);
// enfileire e responda rápido
http_response_code(200);

Entregas e novas tentativas

TentativaEspera
1ªImediata
2ª a 8ª1 min · 5 min · 30 min · 2 h · 6 h · 12 h · 24 h

É considerada entregue a resposta HTTP 2xx em até 10 segundos. Depois de 30 falhas seguidas, o webhook é pausado automaticamente (reative com PATCH {"status": "active"} ou no Painel). O histórico fica em GET /v1/webhooks/{id}/deliveries, e POST /v1/webhooks/{id}/test envia um evento de teste. A ordem de entrega não é garantida: use created_at e data.object.updated_at.

Feed de eventos (sincronização incremental)

GET /v1/events devolve os eventos em ordem cronológica, com filtro opcional types (separados por vírgula). Guarde o cursor e retome de onde parou: é a forma mais robusta de manter uma cópia fiel, e também uma rede de segurança para webhooks perdidos. Os eventos ficam disponíveis por 30 dias.

Consumindo o feed
Node.js// Sincronização incremental: guarde o cursor e retome de onde parou
let cursor = await banco.ler("gcp_cursor");
while (true) {
  const qs = new URLSearchParams({ limit: "200", ...(cursor && { cursor }) });
  const page = await (await fetch(`https://gestaoculturalpro.com.br/api/v1/events?${qs}`, { headers })).json();
  for (const evento of page.data) await aplicar(evento); // idempotente por evento.id
  cursor = page.next_cursor || page.cursor_for_resume || cursor;
  await banco.gravar("gcp_cursor", cursor);
  if (!page.has_more) break;
}

12Receitas de integração

ERP financeiro bidirecional

  1. Mapeie os cadastros. Leia /financial/accounts, /financial/categories e /projects e associe às contas, ao plano de contas e aos centros de custo do ERP. Guarde os ids do GCP no ERP.
  2. Sincronize contatos por CPF/CNPJ. Busque com GET /financial/contacts?document=…; se não existir, crie. Em 409 contact_exists, use o existing_id.
  3. Envie contas a pagar e a receber. POST /financial/transactions com Idempotency-Key igual ao id do título no ERP e, quando houver, o rateio em allocations (projeto e rubrica).
  4. Registre baixas. Pagamento efetuado no ERP: POST /financial/transactions/{id}/settle com data, valor efetivo e bank_transaction_id.
  5. Receba o que muda no GCP. Webhook com transaction.*, ignorando a origem da sua própria chave. Use o feed de eventos para reconciliar diariamente.
  6. Confira saldos. GET /financial/accounts/{id}/statement para bater o extrato e /financial/summary para o fechamento do mês.

Gestão de tarefas

  1. Estruture. Para cada projeto/board da ferramenta, crie ou localize um quadro (/workspace/boards) e suas listas.
  2. Associe pessoas. Leia /workspace/members e associe pelo e-mail.
  3. Sincronize cartões. Crie e atualize com /workspace/cards; mova entre fases alterando list_id; conclua com completed.
  4. Escute mudanças. Webhook com card.* e list.*; card.moved e card.completed indicam a transição.

BI e relatórios (somente consulta)

  1. Carga inicial. Percorra /financial/transactions por período (date_from/date_to), com paginação.
  2. Atualização. Consuma /events a cada poucos minutos e aplique as mudanças pelo data.object.id.
  3. Indicadores prontos. /financial/summary (por mês, categoria, projeto, conta ou centro de custo) e /projects/{id}/financial-summary (execução por rubrica).

Avisos automáticos para a equipe

Com workspace:write, publique em um canal: POST /workspace/channels/{id}/messages com {"text": "Pagamento da NF 4821 confirmado no ERP."}.

13Equivalência com softwares de mercado

Para acelerar o mapeamento, a tabela relaciona os conceitos do GCP aos termos usados por ERPs, sistemas financeiros e ferramentas de gestão de tarefas amplamente usados no Brasil (como TOTVS, SAP Business One, Omie, Conta Azul, Bling, Asana, Trello, Jira, monday.com e ClickUp). Os nomes são citados apenas como referência de mercado; as marcas pertencem aos respectivos titulares.

Financeiro

GCPTermos equivalentes em ERPsObservação
Lançamento expenseConta a pagar · título a pagar · despesadate = pagamento; due_date = vencimento
Lançamento incomeConta a receber · título a receber · receitaPatrocínios, editais, bilheteria, vendas
settle / reopenBaixa / estorno da baixa · liquidaçãoDiferenças ficam em settlements
reconciledConciliação bancáriabank_transaction_id = FITID do OFX
TransferênciaTransferência entre contas · movimentação internaDois lançamentos pareados
ContatoCliente · fornecedor · favorecido · parceiro de negócioChave natural: CPF/CNPJ
CategoriaPlano de contas · natureza financeira · categoriaCódigo hierárquico em code
Centro de custoCentro de custo · departamentoLista em /financial/categories
Projeto + rubrica (allocations)Projeto · obra · centro de resultado + item orçamentárioExclusivo da gestão cultural: execução por rubrica para prestação de contas
PlanejamentoPrevisão · orçamento de caixa · provisãoVira lançamento ao ser processado no GCP

Gestão de tarefas

GCPTermos equivalentes
QuadroProjeto · board · espaço · quadro
Lista (fase)Seção · coluna · status · grupo
CartãoTarefa · card · issue · item
ChecklistSubtarefas · checklist · itens de ação
EtiquetaTag · label · rótulo
members / assignee_idResponsáveis · assignee
custom_fieldsCampos personalizados · custom fields · colunas
blocked_byDependências · bloqueado por
ComentárioComentário · atualização · activity

14Segurança

Na plataforma

HTTPS obrigatório com HSTS · segredo armazenado apenas como SHA-256, com comparação em tempo constante · isolamento por instituição em todas as consultas · permissões por módulo e ação · validade e renovação com transição · limite de requisições · auditoria de cada chamada (rota, resultado, tempo, IP) no Painel · HTML recebido é higienizado · remoções com salvaguardas.

Nos webhooks

Assinatura HMAC-SHA256 com timestamp · somente HTTPS · bloqueio de endereços internos, privados e de metadados, verificado no momento da conexão (protege contra DNS rebinding) · sem seguir redirecionamentos · tempo limite de 10 s · pausa automática após falhas consecutivas.

Checklist do parceiro: chave em cofre de segredos · uma chave por sistema · menor permissão necessária · renovação periódica (90 dias) · validação da assinatura e do timestamp dos webhooks · Idempotency-Key em todo POST · If-Match em alterações · espera exponencial em 429/5xx · registro do X-Request-Id nos seus logs.

15Referência rápida

MétodoRotaPermissãoDescrição
GET/v1/pingqualquerDiagnóstico da chave
GET/v1/financial/accountsfinancial:readListar contas
GET/v1/financial/accounts/{id}financial:readConsultar conta com saldos
POST/v1/financial/accountsfinancial:writeCriar conta
PATCH/v1/financial/accounts/{id}financial:writeAlterar conta
DELETE/v1/financial/accounts/{id}financial:deleteRemover conta sem movimentação
GET/v1/financial/accounts/{id}/statementfinancial:readExtrato com saldo acumulado
GET/v1/financial/transactionsfinancial:readListar lançamentos
GET/v1/financial/transactions/{id}financial:readConsultar lançamento (inclui etag)
POST/v1/financial/transactionsfinancial:writeCriar receita ou despesa
PATCH/v1/financial/transactions/{id}financial:writeAlterar lançamento
POST/v1/financial/transactions/{id}/settlefinancial:writeRegistrar baixa (pagamento ou recebimento)
POST/v1/financial/transactions/{id}/reopenfinancial:writeDesfazer baixa
DELETE/v1/financial/transactions/{id}financial:deleteExcluir lançamento em aberto
POST/v1/financial/transfersfinancial:writeCriar transferência
GET/v1/financial/contactsfinancial:readListar ou buscar
GET/v1/financial/contacts/{id}financial:readConsultar contato
POST/v1/financial/contactsfinancial:writeCriar contato
PATCH/v1/financial/contacts/{id}financial:writeAlterar contato
DELETE/v1/financial/contacts/{id}financial:deleteRemover contato sem lançamentos
GET/v1/financial/categoriesfinancial:readListar categorias, centros de custo e listas
GET/v1/financial/planningfinancial:readListar itens
GET/v1/financial/planning/{id}financial:readConsultar item
POST/v1/financial/planningfinancial:writeCriar item
PATCH/v1/financial/planning/{id}financial:writeAlterar item em rascunho
DELETE/v1/financial/planning/{id}financial:deleteRemover item em rascunho
GET/v1/financial/summaryfinancial:readResumo por período
GET/v1/projectsfinancial:read ou workspace:readListar projetos
GET/v1/projects/{id}financial:read ou workspace:readConsultar projeto com orçamento (budget[])
GET/v1/projects/{id}/financial-summaryfinancial:readExecução orçamentária por rubrica
GET/v1/workspace/membersworkspace:readListar membros ativos
GET/v1/workspace/boardsworkspace:readListar quadros
GET/v1/workspace/boards/{id}workspace:readConsultar quadro com listas, etiquetas e campos personalizados
POST/v1/workspace/boardsworkspace:writeCriar quadro
PATCH/v1/workspace/boards/{id}workspace:writeAlterar título, descrição ou etiquetas
GET/v1/workspace/boards/{id}/listsworkspace:readListar listas (fases)
POST/v1/workspace/boards/{id}/listsworkspace:writeCriar lista
PATCH/v1/workspace/lists/{id}workspace:writeRenomear, reordenar ou arquivar lista
DELETE/v1/workspace/lists/{id}workspace:deleteArquivar lista (?permanent=true remove lista vazia)
GET/v1/workspace/cardsworkspace:readListar cartões de um quadro
GET/v1/workspace/cards/{id}workspace:readConsultar cartão (inclui etag)
POST/v1/workspace/cardsworkspace:writeCriar cartão
PATCH/v1/workspace/cards/{id}workspace:writeAlterar, mover (list_id), concluir ou arquivar
DELETE/v1/workspace/cards/{id}workspace:deleteArquivar cartão (?permanent=true remove definitivamente um cartão já arquivado)
GET/v1/workspace/cards/{id}/commentsworkspace:readListar comentários
POST/v1/workspace/cards/{id}/commentsworkspace:writeComentar
GET/v1/workspace/tasksworkspace:readListar tarefas
GET/v1/workspace/tasks/{id}workspace:readConsultar tarefa
POST/v1/workspace/tasksworkspace:writeCriar tarefa
PATCH/v1/workspace/tasks/{id}workspace:writeAlterar tarefa
DELETE/v1/workspace/tasks/{id}workspace:deleteRemover tarefa (tarefas com Logística: use status cancelled)
GET/v1/workspace/channelsworkspace:readListar canais
GET/v1/workspace/channels/{id}/messagesworkspace:readMensagens recentes (mais novas primeiro)
POST/v1/workspace/channels/{id}/messagesworkspace:writePublicar mensagem
GET/v1/workspace/docsworkspace:readListar documentos colaborativos
GET/v1/eventsleitura do móduloFeed de eventos
GET/v1/events/{id}leitura do móduloConsultar evento
GET/v1/webhooks/event-typesqualquerCatálogo de eventos
GET/v1/webhookswebhooks:manageListar webhooks
POST/v1/webhookswebhooks:manageCadastrar webhook (retorna o secret uma vez)
GET/v1/webhooks/{id}webhooks:manageConsultar webhook
PATCH/v1/webhooks/{id}webhooks:manageAlterar URL, eventos ou status
DELETE/v1/webhooks/{id}webhooks:manageRemover webhook
POST/v1/webhooks/{id}/rotate-secretwebhooks:manageGerar novo secret
POST/v1/webhooks/{id}/testwebhooks:manageEnviar evento de teste
GET/v1/webhooks/{id}/deliverieswebhooks:manageHistórico de entregas
POST/v1/webhooks/{id}/deliveries/{deliveryId}/retrywebhooks:manageReenviar entrega

16Versões e suporte

VersãoDataNovidades
1.0.006/11/2026Lançamento: Módulo Financeiro, Projetos, Espaços de Trabalho, webhooks assinados, feed de eventos, idempotência e controle de versão.

Suporte técnico: abra um chamado em Suporte e Ajuda no GCP (ou peça ao administrador da instituição), informando o request_id, a rota, o horário (Brasília) e a resposta recebida. Nunca envie a chave de API em chamados ou e-mails.