iClips

Lista as agências iClips (chaves de API) ligadas a este install, com id, apelido e nome.

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lista as contas bancárias ativas da agência no iClips (id, nome, isDefault, banco, agência e número da conta). Use o id retornado como account_id ao filtrar iclips_financial_entries. Não tem filtro nem paginação: devolve sempre todas as contas ativas.

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê os lançamentos financeiros do iClips (entradas, saídas e o que está em aberto a pagar e a receber). Ações: - list: exige from e to (AAAA-MM-DD, no máximo 366 dias de intervalo). Filtre por type, account_id, category_id, dre_indicator, destination_id e job_id. Pagine com limit (padrão 50, máximo 200) e offset. - get: detalhe completo de um ou mais lançamentos por entry_ids (em lote, com erro reportado por id). date_field escolhe QUAL data o from/to filtra: entry (padrão) é o entryDate, que para "A Pagar" e "A Receber" é o VENCIMENTO da parcela; payment é o paymentDate, a data da baixa, então só traz o que já foi pago; competence é o competenceDate. Para saber o que vence no mês, use type="A Pagar" (ou "A Receber") com date_field=entry no intervalo do mês: cada parcela é um lançamento próprio. Devolve valor, impostos retidos (irrf e issrf), categoria com o indicador de DRE, conta bancária, nota fiscal vinculada, destinatário (cliente ou fornecedor) e o rateio por centro de custo. Não existe escrita no financeiro: o iClips expõe esse módulo apenas para leitura, por decisão dele. [Flattened action: list]

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "date_field": {
      "type": "string",
      "enum": [
        "entry",
        "payment",
        "competence"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "Entrada",
        "Saída",
        "A Receber",
        "A Pagar"
      ]
    },
    "account_id": {
      "type": "number"
    },
    "category_id": {
      "type": "number"
    },
    "dre_indicator": {
      "type": "string",
      "enum": [
        "DESPESAS OPERACIONAIS",
        "DESPESAS OPERACIONAIS CUSTO VARIÁVEL",
        "DESPESAS OPERACIONAIS CUSTO FIXO",
        "DESPESAS NÃO OPERACIONAIS",
        "IMPOSTOS",
        "PARTICIPAÇÃO NOS LUCROS",
        "RECEITAS OPERACIONAIS",
        "RECEITAS NÃO OPERACIONAIS",
        "RECEITAS TOTAIS",
        "NENHUM",
        "OUTRO"
      ]
    },
    "destination_id": {
      "type": "number"
    },
    "job_id": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "entry_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê os lançamentos financeiros do iClips (entradas, saídas e o que está em aberto a pagar e a receber). Ações: - list: exige from e to (AAAA-MM-DD, no máximo 366 dias de intervalo). Filtre por type, account_id, category_id, dre_indicator, destination_id e job_id. Pagine com limit (padrão 50, máximo 200) e offset. - get: detalhe completo de um ou mais lançamentos por entry_ids (em lote, com erro reportado por id). date_field escolhe QUAL data o from/to filtra: entry (padrão) é o entryDate, que para "A Pagar" e "A Receber" é o VENCIMENTO da parcela; payment é o paymentDate, a data da baixa, então só traz o que já foi pago; competence é o competenceDate. Para saber o que vence no mês, use type="A Pagar" (ou "A Receber") com date_field=entry no intervalo do mês: cada parcela é um lançamento próprio. Devolve valor, impostos retidos (irrf e issrf), categoria com o indicador de DRE, conta bancária, nota fiscal vinculada, destinatário (cliente ou fornecedor) e o rateio por centro de custo. Não existe escrita no financeiro: o iClips expõe esse módulo apenas para leitura, por decisão dele. [Flattened action: get]

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "date_field": {
      "type": "string",
      "enum": [
        "entry",
        "payment",
        "competence"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "Entrada",
        "Saída",
        "A Receber",
        "A Pagar"
      ]
    },
    "account_id": {
      "type": "number"
    },
    "category_id": {
      "type": "number"
    },
    "dre_indicator": {
      "type": "string",
      "enum": [
        "DESPESAS OPERACIONAIS",
        "DESPESAS OPERACIONAIS CUSTO VARIÁVEL",
        "DESPESAS OPERACIONAIS CUSTO FIXO",
        "DESPESAS NÃO OPERACIONAIS",
        "IMPOSTOS",
        "PARTICIPAÇÃO NOS LUCROS",
        "RECEITAS OPERACIONAIS",
        "RECEITAS NÃO OPERACIONAIS",
        "RECEITAS TOTAIS",
        "NENHUM",
        "OUTRO"
      ]
    },
    "destination_id": {
      "type": "number"
    },
    "job_id": {
      "type": "number"
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "entry_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê as notas fiscais de serviço (NFS-e) emitidas pela agência no iClips. Ações: - list: exige from e to (AAAA-MM-DD, no máximo 366 dias, filtrando pela data de emissão). Filtro opcional por status. Pagine com limit (padrão 50, máximo 200) e offset. - get: detalhe completo de uma ou mais notas por invoice_ids (em lote, com erro reportado por id). Devolve valor bruto e líquido, base de cálculo, alíquota e valor do ISS, retenções de PIS, COFINS, INSS, IR e CSLL, a discriminação do serviço, os dados do tomador e do emitente, os números do RPS e o motivo do cancelamento quando o status é cancelled. [Flattened action: list]

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "issued",
        "cancelled",
        "error"
      ]
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "invoice_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê as notas fiscais de serviço (NFS-e) emitidas pela agência no iClips. Ações: - list: exige from e to (AAAA-MM-DD, no máximo 366 dias, filtrando pela data de emissão). Filtro opcional por status. Pagine com limit (padrão 50, máximo 200) e offset. - get: detalhe completo de uma ou mais notas por invoice_ids (em lote, com erro reportado por id). Devolve valor bruto e líquido, base de cálculo, alíquota e valor do ISS, retenções de PIS, COFINS, INSS, IR e CSLL, a discriminação do serviço, os dados do tomador e do emitente, os números do RPS e o motivo do cancelamento quando o status é cancelled. [Flattened action: get]

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string"
    },
    "to": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "issued",
        "cancelled",
        "error"
      ]
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "invoice_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Cria ou atualiza um job (projeto) no iClips. Ações: - create: o data exige titulo (até 100 caracteres), status e exatamente um entre clienteId e grupoClienteId. Opcionais: entradaDate, aprovacaoDate, conclusaoDate (AAAA-MM-DD), prioridade (1=Baixa, 2=Média, 3=Alta), servico, campanha, descricao, briefing, verba, idVerba, idFeeMensal, funcionarioId, auxiliarId, modeloIds (int[]), pecaIds (int[]) e tarefasInput (lista de {titulo, descricao, inicioDate, fimDate, prioridade, ordemExibicao}). - update: exige job_id; o data exige titulo e status. modeloIds, pecaIds e tarefasInput são IGNORADOS aqui, use iclips_job_pieces_write e iclips_job_tasks_write para mexer nas peças e tarefas do job. Códigos de status: 1=Proposta Comercial, 2=Concorrência, 3=Risco, 5=Aguardando Aprovação, 6=Autorizado, 7=Finalizado, 8=Cancelado, 9=Aberto pelo Cliente, 10=Pré Produção, 11=Stand By. Devolve jobId, titulo, sigla, status, totalPecas e totalTarefas. [Flattened action: create] Bulk support: accepts job_ids for batched execution.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "job_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Cria ou atualiza um job (projeto) no iClips. Ações: - create: o data exige titulo (até 100 caracteres), status e exatamente um entre clienteId e grupoClienteId. Opcionais: entradaDate, aprovacaoDate, conclusaoDate (AAAA-MM-DD), prioridade (1=Baixa, 2=Média, 3=Alta), servico, campanha, descricao, briefing, verba, idVerba, idFeeMensal, funcionarioId, auxiliarId, modeloIds (int[]), pecaIds (int[]) e tarefasInput (lista de {titulo, descricao, inicioDate, fimDate, prioridade, ordemExibicao}). - update: exige job_id; o data exige titulo e status. modeloIds, pecaIds e tarefasInput são IGNORADOS aqui, use iclips_job_pieces_write e iclips_job_tasks_write para mexer nas peças e tarefas do job. Códigos de status: 1=Proposta Comercial, 2=Concorrência, 3=Risco, 5=Aguardando Aprovação, 6=Autorizado, 7=Finalizado, 8=Cancelado, 9=Aberto pelo Cliente, 10=Pré Produção, 11=Stand By. Devolve jobId, titulo, sigla, status, totalPecas e totalTarefas. [Flattened action: update] Bulk support: accepts job_ids for batched execution.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "job_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Exclui jobs (projetos) do iClips. É destrutivo e não tem desfazer pela API. Aceita job_ids para remover vários de uma vez, em lote, com erro reportado por id.

{
  "type": "object",
  "properties": {
    "job_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "required": [
    "job_ids"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Vincula uma peça do catálogo a um job existente, ou atualiza uma peça já vinculada a ele. Ações: - add: exige job_id e data.pecaId (id da peça no catálogo, veja iclips_pieces). Opcionais no data: titulo, descricao e prioridade (1, 2 ou 3). Devolve jobPecaId, que é o id da peça DENTRO do job e o que se usa no update. - update: exige job_id e job_piece_id (o jobPecaId, NÃO o pecaId do catálogo). Todo campo do data é opcional, mande só o que muda: titulo, descricao, formato, servico e prioridade. [Flattened action: add] Bulk support: accepts job_ids, job_piece_ids for batched execution.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "number"
    },
    "job_piece_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "job_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "job_piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "job_id",
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Vincula uma peça do catálogo a um job existente, ou atualiza uma peça já vinculada a ele. Ações: - add: exige job_id e data.pecaId (id da peça no catálogo, veja iclips_pieces). Opcionais no data: titulo, descricao e prioridade (1, 2 ou 3). Devolve jobPecaId, que é o id da peça DENTRO do job e o que se usa no update. - update: exige job_id e job_piece_id (o jobPecaId, NÃO o pecaId do catálogo). Todo campo do data é opcional, mande só o que muda: titulo, descricao, formato, servico e prioridade. [Flattened action: update] Bulk support: accepts job_ids, job_piece_ids for batched execution.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "number"
    },
    "job_piece_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "job_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "job_piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "job_id",
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Cria ou atualiza uma tarefa manual dentro de um job existente no iClips. Ações: - create: exige job_id e data.titulo (até 150 caracteres). Opcionais no data: descricao, inicioDate, fimDate (AAAA-MM-DD), prioridade (1, 2 ou 3) e ordemExibicao. Devolve idTarefaJob, que é o id usado no update. - update: exige job_id e task_id (o idTarefaJob). Todo campo do data é opcional, mande só o que muda. Os nomes de campo da ESCRITA (titulo, inicioDate, fimDate) são diferentes dos que o iclips_projects_extract devolve na LEITURA (tituloAtividade, inicioPlanejado, fimPlanejado). [Flattened action: create] Bulk support: accepts job_ids, task_ids for batched execution.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "number"
    },
    "task_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "job_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "task_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "job_id",
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Cria ou atualiza uma tarefa manual dentro de um job existente no iClips. Ações: - create: exige job_id e data.titulo (até 150 caracteres). Opcionais no data: descricao, inicioDate, fimDate (AAAA-MM-DD), prioridade (1, 2 ou 3) e ordemExibicao. Devolve idTarefaJob, que é o id usado no update. - update: exige job_id e task_id (o idTarefaJob). Todo campo do data é opcional, mande só o que muda. Os nomes de campo da ESCRITA (titulo, inicioDate, fimDate) são diferentes dos que o iclips_projects_extract devolve na LEITURA (tituloAtividade, inicioPlanejado, fimPlanejado). [Flattened action: update] Bulk support: accepts job_ids, task_ids for batched execution.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "number"
    },
    "task_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "job_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "task_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "job_id",
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê o catálogo de peças da agência no iClips. Ações: - list: busca textual opcional por q, mais filtros por categoria, status e basedOnTemplateId. Pagine com page e pageSize (padrão 20). - get: detalhe de uma ou mais peças por piece_ids, incluindo o workflowJson e o checklistJson completos (em lote, com erro reportado por id). [Flattened action: list]

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string"
    },
    "categoria": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "basedOnTemplateId": {
      "type": "string"
    },
    "page": {
      "type": "number"
    },
    "pageSize": {
      "type": "number"
    },
    "piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê o catálogo de peças da agência no iClips. Ações: - list: busca textual opcional por q, mais filtros por categoria, status e basedOnTemplateId. Pagine com page e pageSize (padrão 20). - get: detalhe de uma ou mais peças por piece_ids, incluindo o workflowJson e o checklistJson completos (em lote, com erro reportado por id). [Flattened action: get]

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string"
    },
    "categoria": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "basedOnTemplateId": {
      "type": "string"
    },
    "page": {
      "type": "number"
    },
    "pageSize": {
      "type": "number"
    },
    "piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Cria ou atualiza uma peça no catálogo do iClips, ou marca um item do checklist. Ações: - create: o data exige name (até 255 caracteres) e exatamente UM entre basedOnTemplateId e workflowJson. Opcionais: description, valorDecimal, valorSindraproCriacaoDecimal, valorSindraproAdaptacaoDecimal, valorSindraproFinalizacaoDecimal, valorTotalDecimal, exibirBool, digitalBool, isFlexible, briefingCliente, pecaCliente, idSindicato, tempoMedio, instrucao, checklistJson e categoriaIds (int[]). Devolve o id da peça nova em data. - update: exige piece_id; o data exige name, workflowJson e checklistJson (este endpoint SUBSTITUI os dois, então leia a peça antes com iclips_pieces action=get). - checklist: exige piece_id e data {itemId, done}. Marca um item do checklist de produção como concluído (true) ou pendente (false). Use iclips_workflow_templates para descobrir o basedOnTemplateId e iclips_piece_categories para os categoriaIds. [Flattened action: create] Bulk support: accepts piece_ids for batched execution.

{
  "type": "object",
  "properties": {
    "piece_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Cria ou atualiza uma peça no catálogo do iClips, ou marca um item do checklist. Ações: - create: o data exige name (até 255 caracteres) e exatamente UM entre basedOnTemplateId e workflowJson. Opcionais: description, valorDecimal, valorSindraproCriacaoDecimal, valorSindraproAdaptacaoDecimal, valorSindraproFinalizacaoDecimal, valorTotalDecimal, exibirBool, digitalBool, isFlexible, briefingCliente, pecaCliente, idSindicato, tempoMedio, instrucao, checklistJson e categoriaIds (int[]). Devolve o id da peça nova em data. - update: exige piece_id; o data exige name, workflowJson e checklistJson (este endpoint SUBSTITUI os dois, então leia a peça antes com iclips_pieces action=get). - checklist: exige piece_id e data {itemId, done}. Marca um item do checklist de produção como concluído (true) ou pendente (false). Use iclips_workflow_templates para descobrir o basedOnTemplateId e iclips_piece_categories para os categoriaIds. [Flattened action: update] Bulk support: accepts piece_ids for batched execution.

{
  "type": "object",
  "properties": {
    "piece_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Cria ou atualiza uma peça no catálogo do iClips, ou marca um item do checklist. Ações: - create: o data exige name (até 255 caracteres) e exatamente UM entre basedOnTemplateId e workflowJson. Opcionais: description, valorDecimal, valorSindraproCriacaoDecimal, valorSindraproAdaptacaoDecimal, valorSindraproFinalizacaoDecimal, valorTotalDecimal, exibirBool, digitalBool, isFlexible, briefingCliente, pecaCliente, idSindicato, tempoMedio, instrucao, checklistJson e categoriaIds (int[]). Devolve o id da peça nova em data. - update: exige piece_id; o data exige name, workflowJson e checklistJson (este endpoint SUBSTITUI os dois, então leia a peça antes com iclips_pieces action=get). - checklist: exige piece_id e data {itemId, done}. Marca um item do checklist de produção como concluído (true) ou pendente (false). Use iclips_workflow_templates para descobrir o basedOnTemplateId e iclips_piece_categories para os categoriaIds. [Flattened action: checklist] Bulk support: accepts piece_ids for batched execution.

{
  "type": "object",
  "properties": {
    "piece_id": {
      "type": "number"
    },
    "data": {
      "type": "string"
    },
    "account": {
      "type": "string"
    },
    "piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    }
  },
  "required": [
    "data"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Exclui peças do catálogo do iClips (o provider faz exclusão lógica). Aceita piece_ids para remover várias de uma vez, em lote, com erro reportado por id.

{
  "type": "object",
  "properties": {
    "piece_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "required": [
    "piece_ids"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê os modelos de workflow configurados na agência no iClips. Ações: - list: todos os templates com id, nome e descricao (sem o workflowJson). - get: detalhe de um ou mais templates por template_ids, incluindo o workflowJson completo (em lote, com erro reportado por id). Use o id como basedOnTemplateId ao criar uma peça com iclips_pieces_write. [Flattened action: list]

{
  "type": "object",
  "properties": {
    "template_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lê os modelos de workflow configurados na agência no iClips. Ações: - list: todos os templates com id, nome e descricao (sem o workflowJson). - get: detalhe de um ou mais templates por template_ids, incluindo o workflowJson completo (em lote, com erro reportado por id). Use o id como basedOnTemplateId ao criar uma peça com iclips_pieces_write. [Flattened action: get]

{
  "type": "object",
  "properties": {
    "template_ids": {
      "type": "array",
      "items": {
        "type": "number"
      }
    },
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lista as categorias de peça disponíveis na agência (id e nome). Ações: - list: a lista completa de categorias. - dropdown: as mesmas categorias no formato simplificado que o iClips serve para campos de seleção. Use esses ids em categoriaIds ao criar ou atualizar uma peça. [Flattened action: list]

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Lista as categorias de peça disponíveis na agência (id e nome). Ações: - list: a lista completa de categorias. - dropdown: as mesmas categorias no formato simplificado que o iClips serve para campos de seleção. Use esses ids em categoriaIds ao criar ou atualizar uma peça. [Flattened action: dropdown]

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Extrai do iClips a hierarquia completa de projetos de um período: Jobs, Peças, Workflows, Atividades e Tarefas, até os apontamentos de hora. É o endereço para BI, exportação e relatório. Responde o que as outras tools não respondem, como quem trabalhou quantas horas em qual peça de qual job de qual cliente, com o departamento e o valor/hora do executor. Exige dataInicio e dataFim (AAAA-MM-DDTHH:mm:ss, no máximo 31 dias de intervalo, filtrando pela data de entrada do job). Opcionalmente idCliente ou idGrupoCliente. Pagine com page e pageSize (padrão 20, máximo 50), lendo meta.totalCount. O iClips limita este endereço a 10 requisições por minuto por chave: varra mês a mês, não dispare em paralelo.

{
  "type": "object",
  "properties": {
    "dataInicio": {
      "type": "string"
    },
    "dataFim": {
      "type": "string"
    },
    "idCliente": {
      "type": "number"
    },
    "idGrupoCliente": {
      "type": "number"
    },
    "page": {
      "type": "number"
    },
    "pageSize": {
      "type": "number"
    },
    "account": {
      "type": "string"
    }
  },
  "required": [
    "dataInicio",
    "dataFim"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Show the current MCP platform and adapter versions.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Report a bug, missing feature, or send feedback. Include the conversation array with recent messages for reproduction.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    },
    "context": {
      "default": "",
      "type": "string"
    },
    "conversation": {
      "default": "[]",
      "type": "string"
    }
  },
  "required": [
    "message"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Returns connection status and URLs. When all providers are connected, returns authenticated:true and empty pending[]. When credentials are missing, returns connect_url for the toolkit and per-install URLs.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Returns the current toolkit state: installed MCPs, their connection status, the accounts connected to each one, and how many catalog tools each exposes.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The official mcp.ai marketplace — the in-platform catalog of every MCP/tool, AND the way to run them. Covers capability requests like "find an MCP that does X", "consulta um CPF", "is there a tool for Y". Core flow: action=search discovers MCPs by intent → describe returns one MCP's full profile (every tool with its id + params, pricing, auth) so you pick the right tool_id → invoke RUNS that tool. KEY: invoke works even when the MCP is NOT installed — it runs the tool pontualmente (one-off), without adding the MCP to the toolkit and without bloating the tool list. If the MCP needs a credential/login, invoke returns a connect link; if it is paid and the wallet is empty, invoke returns a checkout/top-up link (the user opens it, then you retry). Use install only to make an MCP PERMANENT in the active toolkit (its tools then show up natively in future sessions); prefer invoke for a single/occasional use. list_tools lists what is callable right now. subscribe/cancel handle per-MCP billing; report_bug sends feedback; request_mcp asks us to build a NEW MCP when nothing fits. Search/describe flag installed_in_toolkit vs installed_in_workspace. Writes (install/uninstall/subscribe/cancel and the one-off install behind invoke) require workspace owner/admin. It also carries the mcp.ai PROMPT LIBRARY, which is about ready-made prompt TEXT rather than MCPs: search_prompts finds one, get_prompt returns its full text with {{variables}} filled, and publish_prompt saves a prompt and returns a shareable mcp.ai/p/<slug> link that opens without login.

{
  "type": "object",
  "properties": {
    "action": {
      "default": "search",
      "type": "string",
      "enum": [
        "search",
        "describe",
        "install",
        "uninstall",
        "subscribe",
        "cancel",
        "resume",
        "report_bug",
        "request_mcp",
        "list_tools",
        "invoke",
        "search_prompts",
        "get_prompt",
        "publish_prompt"
      ]
    },
    "query": {
      "default": "",
      "type": "string"
    },
    "mcp_id": {
      "default": "",
      "type": "string"
    },
    "limit": {
      "default": 10,
      "type": "number"
    },
    "tier_slug": {
      "default": "",
      "type": "string"
    },
    "immediate": {
      "default": false,
      "type": "boolean"
    },
    "cancel_reason": {
      "type": "string",
      "enum": [
        "too_expensive",
        "missing_features",
        "switched_service",
        "unused",
        "customer_service",
        "too_complex",
        "low_quality",
        "other"
      ]
    },
    "cancel_comment": {
      "default": "",
      "type": "string"
    },
    "message": {
      "default": "",
      "type": "string"
    },
    "report_context": {
      "default": "",
      "type": "string"
    },
    "conversation": {
      "default": "[]",
      "type": "string"
    },
    "request_name": {
      "default": "",
      "type": "string"
    },
    "request_details": {
      "default": "",
      "type": "string"
    },
    "tool_id": {
      "default": "",
      "type": "string"
    },
    "arguments": {
      "default": "{}",
      "type": "string"
    },
    "prompt_slug": {
      "default": "",
      "type": "string"
    },
    "prompt_vars": {
      "default": "{}",
      "type": "string"
    },
    "prompt_category": {
      "default": "",
      "type": "string"
    },
    "prompt_tool": {
      "default": "",
      "type": "string"
    },
    "prompt_title": {
      "default": "",
      "type": "string"
    },
    "prompt_description": {
      "default": "",
      "type": "string"
    },
    "prompt_body": {
      "default": "",
      "type": "string"
    },
    "prompt_targets": {
      "default": [],
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "claude",
          "chatgpt",
          "cursor",
          "lovable"
        ]
      }
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}

MCP.AI for IDE agents (Cursor, etc.): log in in the browser, copy the access token. Best: add it to this server's config as a header `Authorization: Bearer <token>` for a permanent, non-expiring connection. Or paste it here for a session-only login: call with { token: "<jwt>" } after the user pastes, or with no args to get the link.

{
  "type": "object",
  "properties": {
    "token": {
      "type": "string"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}