> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://ajuda.groner.app/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# API CRM — tarefas, agenda, formulários e pagamentos

Referência de **CRM** para integrar as operações descritas abaixo.

[Guia principal e downloads](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/) · [Exemplos](#2-exemplos-de-requisicao-e-resposta) · [Endpoints](#2-referencia-dos-endpoints)

|| Revisão: **14/10/2026**. Classificação conferida nos clients dos produtos e nas rotas registradas do servidor. Respostas abaixo são exemplos completos do contrato escolhido com dados fictícios, não capturas de produção.

## Índice clicável

[Tarefas e atividades — Tarefa](#3-tarefas-e-atividades-tarefa) · [Tipos de tarefa — TipoTarefa](#3-tipos-de-tarefa-tipotarefa) · [Status de tarefa — StatusTarefa](#3-status-de-tarefa-statustarefa) · [Modelos de tarefa — ModeloTarefa](#3-modelos-de-tarefa-modelotarefa) · [Disponibilidade de horários — DisponibilidadeAgenda](#3-disponibilidade-de-horarios-disponibilidadeagenda) · [Integração Google Agenda — GoogleAgenda](#3-integracao-google-agenda-googleagenda) · [Pagamento do negócio no CRM — Pagamento](#3-pagamento-do-negocio-no-crm-pagamento) · [Parcelas do negócio no CRM — ParcelaPagamento](#3-parcelas-do-negocio-no-crm-parcelapagamento) · [Formas de pagamento — FormaPagamento](#3-formas-de-pagamento-formapagamento) · [Formas de financiamento — FormaPagamentoFinanciamento](#3-formas-de-financiamento-formapagamentofinanciamento) · [Contratos do negócio — Contrato](#3-contratos-do-negocio-contrato) · [Formulários de captação — Formulario](#3-formularios-de-captacao-formulario) · [Cadastro de monitoramento no CRM — Monitoramento](#3-cadastro-de-monitoramento-no-crm-monitoramento) · [Automações da aba de monitoramento do CRM — AutomacoesStatusMonitoramento](#3-automacoes-da-aba-de-monitoramento-do-crm-automacoesstatusmonitoramento)

---

## Como usar esta referência

**API central:** `https://{tenant}.api.groner.app`. Use `API_URL` com o host da empresa, sem `/api`. Envie Bearer. O middleware retorna o envelope `Content`; tabelas avançadas, downloads e 204 possuem transporte próprio. A operação e a função do usuário determinam o acesso.

Substitua tenant/token pelo ambiente autorizado e IDs de exemplo pelos cadastros reais. Os comandos são Bash; no PowerShell use `curl.exe` e adapte variáveis e continuação de linha.

**Recursos compartilhados:** a organização segue a finalidade principal da operação, não exclusividade de produto. Um client consumir um controller não significa que todas as actions desse controller sejam liberadas para aquele usuário. Consulte guard e contrato.

## Exemplos de requisição e resposta

### Listar tarefas

**Requisição completa (Bash):**

```bash
curl --request GET \
  --url "$API_URL/api/Tarefa?PageNumber=1&PageSize=25" \
  --header "Authorization: Bearer $TOKEN" \
  --header "Accept: application/json"
```

**Resposta ilustrativa — HTTP 200:**

```json
{
  "Version": "1.0.0.0",
  "StatusCode": 200,
  "Message": "Requisição efetuada com suceesso.",
  "Content": {
    "summary": null,
    "totalItems": 0,
    "pageNumber": 1,
    "pageSize": 25,
    "ids": null,
    "list": [],
    "totalPages": 0,
    "hasPreviousPage": false,
    "hasNextPage": false,
    "nextPageNumber": 0,
    "previousPageNumber": 1
  }
}
```

A paginação acima é do contrato `PagingParams`. Disponibilidade de agenda, agendamento e Google Agenda têm filtros próprios: consulte a assinatura da action escolhida.

---

## Referência dos endpoints

### Tarefas e atividades — Tarefa

**Uso encontrado nos clients:** Groner light, Groner os. Compartilhamento não amplia permissões.

#### `GET /api/Tarefa/TabelaAvancada`

**query** `loadOptions`: `DataSourceLoadOptions`.

**Retorno declarado:** `Task<LoadResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Tarefa/CardsIniciais`

**query** `filtro`: `FiltroTarefaInputDTO` — [FiltroTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtrotarefainputdto); **query** `pageSize`: `int`.

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Tarefa/Summary`

**query** `filtro`: `FiltroTarefaInputDTO` — [FiltroTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtrotarefainputdto).

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Tarefa`

**query** `filtro`: `FiltroTarefaInputDTO` — [FiltroTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtrotarefainputdto); **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `Task<ActionResult<PagedList<TarefaListDTO>>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Tarefa/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa`

**body** `model`: `TarefaInputDTO` — [TarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tarefainputdto).

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/{id}/AdicionarStatus`

**path** `id`: `long`; **body** `model`: `AddStatusInputDTO` — [AddStatusInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addstatusinputdto).

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Tarefa/{id}/Comentarios`

**path** `id`: `long`.

**Retorno declarado:** `Task<List<ComentarioTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/{id}/Comentario`

**path** `id`: `long`; **body** `model`: `AddComentarioInputDTO` — [AddComentarioInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addcomentarioinputdto).

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Tarefa/Comentario/{id}`

**path** `id`: `long`; **body** `model`: `EditarNomeInputDTO` — [EditarNomeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarnomeinputdto).

**Retorno declarado:** `Task<ActionResult<ComentarioTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Tarefa/Comentario/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/{id}/Arquivo/{arquivoId}`

**path** `id`: `long`; **path** `arquivoId`: `long`.

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/{id}/Arquivos`

**path** `id`: `long`; **body** `arquivoIds`: `List<long>`.

**Retorno declarado:** `Task<ActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Tarefa/Arquivo/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/{id}/Checklist`

**path** `id`: `long`; **body** `model`: `AddChecklistInputDTO` — [AddChecklistInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addchecklistinputdto).

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Tarefa/Checklist/{id}`

**path** `id`: `long`; **body** `model`: `EditarNomeInputDTO` — [EditarNomeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarnomeinputdto).

**Retorno declarado:** `Task<ActionResult<Checklist>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Tarefa/Checklist/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/Checklist/{id}/ChecklistItem`

**path** `id`: `long`; **body** `model`: `AddChecklistInputDTO` — [AddChecklistInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addchecklistinputdto).

**Retorno declarado:** `Task<ActionResult<Checklist>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Tarefa/ChecklistItem/{id}`

**path** `id`: `long`; **body** `model`: `EditarNomeInputDTO` — [EditarNomeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarnomeinputdto).

**Retorno declarado:** `Task<ActionResult<CheckItem>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Tarefa/ChecklistItem/{id}/AlterarStatus`

**path** `id`: `long`; **query** `status`: `StatusCheckItemEnum`.

**Retorno declarado:** `Task<ActionResult<CheckItem>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Tarefa/ChecklistItem/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Tarefa/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Tarefa/{id}`

**path** `id`: `long`; **query** `manterSubtarefas`: `bool?` (padrão `false`).

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Tarefa/{id}/AlterarProjeto/{projetoId}`

**path** `id`: `long`; **path** `projetoId`: `long`.

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Tarefa/{id}/AlterarProposta/{statusLeadId}`

**path** `id`: `long`; **path** `statusLeadId`: `long`.

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/{id}/AdicionarMembro/{usuarioId}`

**path** `id`: `long`; **path** `usuarioId`: `long`.

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Tarefa/{id}/RemoverMembro/{usuarioId}`

**path** `id`: `long`; **path** `usuarioId`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Tarefa/ExcluirLista`

**body** `ids`: `List<long>`; **query** `manterSubtarefas`: `bool?` (padrão `false`).

**Retorno declarado:** `Task<ActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/EditarDataTarefas`

**body** `body`: `EditarDataTarefasInputDTO` — [EditarDataTarefasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editardatatarefasinputdto).

**Retorno declarado:** `Task<string>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/EditarStatusTarefas`

**body** `body`: `EditarStatusTarefasInputDTO` — [EditarStatusTarefasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarstatustarefasinputdto).

**Retorno declarado:** `Task<string>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/GerarDePendencias`

**body** `body`: `GerarTarefasDePendenciasInputDTO` — [GerarTarefasDePendenciasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-gerartarefasdependenciasinputdto).

**Retorno declarado:** `Task<ActionResult<List<Tarefa>>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Tarefa/PorTipoEStatus`

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/EditarResponsaveisTarefas`

**body** `body`: `EditarResponsaveisTarefasInputDTO` — [EditarResponsaveisTarefasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarresponsaveistarefasinputdto).

**Retorno declarado:** `Task<string>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/AlterarEtiquetas/{id}`

**path** `id`: `long`; **query** `etiquetasId`: `long[]`; **query** `add`: `bool` (padrão `false`).

**Retorno declarado:** `Task<ActionResult<Tarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/AlterarEtiquetasEmLote`

**body** `model`: `AlterarTarefasEtiquetasInputDTO` — [AlterarTarefasEtiquetasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-alterartarefasetiquetasinputdto); **query** `add`: `bool` (padrão `false`).

**Retorno declarado:** `Task<ActionResult<string>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/EditarTarefaPaiTarefas`

**body** `body`: `EditarTarefaPaiTarefasInputDTO` — [EditarTarefaPaiTarefasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editartarefapaitarefasinputdto).

**Retorno declarado:** `Task<string>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/AlterarProjetoEmLote`

**body** `body`: `AlterarTarefasNegocioEmLoteInputDTO` — [AlterarTarefasNegocioEmLoteInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-alterartarefasnegocioemloteinputdto).

**Retorno declarado:** `Task<string>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Tarefa/EditarTipoTarefas`

**body** `body`: `EditarTipoTarefasInputDTO` — [EditarTipoTarefasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editartipotarefasinputdto).

**Retorno declarado:** `Task<string>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor, Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

### Tipos de tarefa — TipoTarefa

**Uso encontrado nos clients:** Groner light, Groner os. Compartilhamento não amplia permissões.

#### `GET /api/TipoTarefa`

**query** `filtro`: `FiltroTipoTarefaInputDTO` — [FiltroTipoTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtrotipotarefainputdto); **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `ActionResult<PagedList<TipoTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/TipoTarefa/{id}`

**path** `id`: `long`.

**Retorno declarado:** `ActionResult<TipoTarefa>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/TipoTarefa`

**body** `model`: `TipoTarefaInputDTO` — [TipoTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tipotarefainputdto).

**Retorno declarado:** `Task<ActionResult<TipoTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/TipoTarefa/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<TipoTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/TipoTarefa/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/TipoTarefa/ExcluirLista`

**body** `ids`: `List<long>`.

**Retorno declarado:** `Task<ActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/TipoTarefa/Objetivos`

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

**Retorno declarado:** `dynamic`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/TipoTarefa/CopiarCamposPersonalizados`

**body** `body`: `CopiarCamposPersonalizadosTipoTarefaInputDTO` — [CopiarCamposPersonalizadosTipoTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-copiarcampospersonalizadostipotarefainputdto).

**Retorno declarado:** `Task<string>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/TipoTarefa/AgrupadosPorSetor`

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

**Retorno declarado:** `Task<List<TiposTarefasPorSetorDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

### Status de tarefa — StatusTarefa

**Uso encontrado nos clients:** Groner light, Groner os. Compartilhamento não amplia permissões.

#### `GET /api/StatusTarefa`

**query** `pagingParams`: `PagingParams`; **query** `query`: `string`; **query** `incluirStatusAgente`: `bool?` (padrão `null`).

**Retorno declarado:** `ActionResult<PagedList<StatusTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor, Vendedor, Tecnico,Supervisor,Gerente.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/StatusTarefa/{id}`

**path** `id`: `long`.

**Retorno declarado:** `ActionResult<StatusTarefa>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor, Vendedor, Tecnico,Supervisor,Gerente.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/StatusTarefa`

**body** `model`: `StatusTarefaInputDto` — [StatusTarefaInputDto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-statustarefainputdto).

**Retorno declarado:** `Task<ActionResult<StatusTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor, Vendedor, Tecnico,Supervisor,Gerente.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/StatusTarefa/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<StatusTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor, Vendedor, Tecnico,Supervisor,Gerente.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/StatusTarefa/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor, Vendedor, Tecnico,Supervisor,Gerente.

[Voltar ao índice](#2-indice-clicavel)

### Modelos de tarefa — ModeloTarefa

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/ModeloTarefa`

**query** `filtro`: `ItemModeloTarefaFiltroInputDTO` — [ItemModeloTarefaFiltroInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-itemmodelotarefafiltroinputdto); **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `ActionResult<PagedList<ItemModeloTarefaOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/ModeloTarefa/{id}`

**path** `id`: `long`.

**Retorno declarado:** `ActionResult<ItemModeloTarefa>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/ModeloTarefa`

**body** `model`: `ItemModeloTarefaInputDTO` — [ItemModeloTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-itemmodelotarefainputdto).

**Retorno declarado:** `Task<ActionResult<ItemModeloTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/ModeloTarefa/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<ItemModeloTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/ModeloTarefa/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/ModeloTarefa/AdicionarCheckList/{id}`

**path** `id`: `long`; **query** `model`: `AdicionarCheckListModeloTarefaInputDTO` — [AdicionarCheckListModeloTarefaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-adicionarchecklistmodelotarefainputdto).

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/ModeloTarefa/RemoverChecklist/{id}`

**path** `id`: `long`; **query** `idChecklist`: `long`.

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/ModeloTarefa/AlterarFuncoes/{id}`

**path** `id`: `long`; **query** `funcoesId`: `long[]`.

**Retorno declarado:** `Task<ActionResult<ItemModeloTarefa>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/ModeloTarefa/CardsIniciais`

**query** `etapaId`: `long`.

**Retorno declarado:** `Task<dynamic>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

### Disponibilidade de horários — DisponibilidadeAgenda

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/DisponibilidadeAgenda`

**query** `tipoTarefaId`: `long`; **query** `usuarioId`: `long`; **query** `data`: `string`; **query** `duracaoMinutos`: `int`; **query** `passoMinutos`: `int` (padrão `30`); **query** `dias`: `int` (padrão `1`); **query** `horaMinima`: `string` (padrão `null`); **query** `horaMaxima`: `string` (padrão `null`); **query** `tz`: `string` (padrão `null`).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/DisponibilidadeAgenda/Reuniao`

**query** `usuarioId`: `long`; **query** `data`: `string`; **query** `duracaoMinutos`: `int` (padrão `60`); **query** `passoMinutos`: `int` (padrão `30`); **query** `dias`: `int` (padrão `1`); **query** `horaMinima`: `string` (padrão `null`); **query** `horaMaxima`: `string` (padrão `null`); **query** `tz`: `string` (padrão `null`).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

### Integração Google Agenda — GoogleAgenda

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/GoogleAgenda/usuario/{usuarioId}`

**path** `usuarioId`: `long`; **query** `inicio`: `DateTime`; **query** `fim`: `DateTime`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/GoogleAgenda/usuario/{usuarioId}/acesso`

**path** `usuarioId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/GoogleAgenda/usuario/{usuarioId}/calendarios`

**path** `usuarioId`: `long`; **query** `somenteEscrita`: `bool` (padrão `true`).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/GoogleAgenda/configuracao`

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/GoogleAgenda/usuario/{usuarioId}/vincular`

**path** `usuarioId`: `long`; **body** `input`: `VincularCalendarioGoogleInputDTO` — [VincularCalendarioGoogleInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-vincularcalendariogoogleinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/GoogleAgenda/usuario/{usuarioId}/calendario`

**path** `usuarioId`: `long`; **body** `input`: `CriarCalendarioGoogleInputDTO` — [CriarCalendarioGoogleInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-criarcalendariogoogleinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/GoogleAgenda`

**body** `input`: `CriarEventoGoogleInputDTO` — [CriarEventoGoogleInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-criareventogoogleinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/GoogleAgenda/usuario/{usuarioId}/evento/{googleEventId}`

**path** `usuarioId`: `long`; **path** `googleEventId`: `string`; **body** `input`: `EditarEventoGoogleInputDTO` — [EditarEventoGoogleInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editareventogoogleinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/GoogleAgenda/usuario/{usuarioId}/evento/{googleEventId}`

**path** `usuarioId`: `long`; **path** `googleEventId`: `string`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/GoogleAgenda/usuario/{usuarioId}/importar`

**path** `usuarioId`: `long`; **body** `input`: `ImportarEventoInputDTO` — [ImportarEventoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-importareventoinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/GoogleAgenda/tarefa/{tarefaId}/sincronizar`

**path** `tarefaId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/GoogleAgenda/usuario/{usuarioId}/sincronizar`

**path** `usuarioId`: `long`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

### Pagamento do negócio no CRM — Pagamento

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/AbaComplementar/Pagamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Pagamento`

**query** `projetoId`: `long`.

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/AbaComplementar/Pagamento`

**body** `dto`: `PagamentoInputDTO` — [PagamentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-pagamentoinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/AbaComplementar/Pagamento/{id}`

**path** `id`: `long`; **body** `dto`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Pagamento/Lista`

**query** `filtro`: `FiltroPagamentoInputDTO` — [FiltroPagamentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtropagamentoinputdto); **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `Task<ActionResult<PagedList<dynamic>>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/AbaComplementar/Pagamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Pagamento/Summary`

**query** `filtro`: `FiltroPagamentoInputDTO` — [FiltroPagamentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtropagamentoinputdto).

**Retorno declarado:** `Task<SummaryPagamentoDTO>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Pagamento/TabelaAvancada`

**query** `loadOptions`: `DataSourceLoadOptions`.

**Retorno declarado:** `Task<LoadResult>`. **Acesso:** Acesso sujeito às regras do ambiente; use a credencial da integração e confirme a permissão desta operação.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Pagamento/PropriedadesParaModelo`

Sem parâmetros de cliente declarados na assinatura; confira transportes especiais na operação..

**Retorno declarado:** `IEnumerable<string>`. **Acesso:** Acesso sujeito às regras do ambiente; use a credencial da integração e confirme a permissão desta operação.

[Voltar ao índice](#2-indice-clicavel)

### Parcelas do negócio no CRM — ParcelaPagamento

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/AbaComplementar/ParcelaPagamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ParcelaPagamento>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/ParcelaPagamento/PorPagamento/{pagamentoId}`

**path** `pagamentoId`: `long`; **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `Task<PagedList<ParcelaPagamento>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/AbaComplementar/ParcelaPagamento`

**body** `dto`: `ParcelaPagamentoInputDTO` — [ParcelaPagamentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-parcelapagamentoinputdto).

**Retorno declarado:** `Task<ParcelaPagamento>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/AbaComplementar/ParcelaPagamento/{id}`

**path** `id`: `long`; **body** `dto`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ParcelaPagamento>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/AbaComplementar/ParcelaPagamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

### Formas de pagamento — FormaPagamento

**Uso encontrado nos clients:** Groner erp, Groner light. Compartilhamento não amplia permissões.

#### `GET /api/FormaPagamento`

**query** `query`: `string`; **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `ActionResult<PagedList<FormaPagamento>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/FormaPagamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `ActionResult<FormaPagamento>`. **Acesso:** Bearer; perfis declarados: Administrador, Vendedor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/FormaPagamento`

**body** `model`: `FormaPagamentoInputDTO` — [FormaPagamentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-formapagamentoinputdto).

**Retorno declarado:** `Task<ActionResult<FormaPagamento>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/FormaPagamento/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<FormaPagamento>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/FormaPagamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

### Formas de financiamento — FormaPagamentoFinanciamento

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/FormaPagamentoFinanciamento`

**query** `query`: `string`; **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `ActionResult<PagedList<FormaPagamentoFinanciamento>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/FormaPagamentoFinanciamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `ActionResult<FormaPagamentoFinanciamento>`. **Acesso:** Bearer; perfis declarados: Administrador, Vendedor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/FormaPagamentoFinanciamento`

**body** `model`: `NomeInputDto` — [NomeInputDto](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-nomeinputdto).

**Retorno declarado:** `Task<ActionResult<FormaPagamentoFinanciamento>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/FormaPagamentoFinanciamento/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<FormaPagamentoFinanciamento>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/FormaPagamentoFinanciamento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

### Contratos do negócio — Contrato

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/AbaComplementar/Contrato/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<ContratoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Contrato`

**query** `projetoId`: `long`.

**Retorno declarado:** `Task<ActionResult<ContratoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/AbaComplementar/Contrato`

**body** `dto`: `ContratoInputDTO` — [ContratoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-contratoinputdto).

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/AbaComplementar/Contrato/{id}`

**path** `id`: `long`; **body** `dto`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<ContratoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Contrato/TabelaAvancada`

**query** `loadOptions`: `DataSourceLoadOptions`.

**Retorno declarado:** `Task<LoadResult>`. **Acesso:** Acesso sujeito às regras do ambiente; use a credencial da integração e confirme a permissão desta operação.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Contrato/Lista`

**query** `filtro`: `FiltroContratoInputDTO` — [FiltroContratoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-filtrocontratoinputdto); **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `Task<PagedList<Contrato>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/AbaComplementar/Contrato/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

### Formulários de captação — Formulario

#### `GET /api/Formulario`

**query** `filtro`: `QueryFiltroInputDTO` — [QueryFiltroInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-queryfiltroinputdto); **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `ActionResult<PagedList<Formulario>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Formulario/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<Formulario>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Formulario`

**body** `model`: `CriarFormularioInputDTO` — [CriarFormularioInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-criarformularioinputdto).

**Retorno declarado:** `Task<ActionResult<Formulario>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Formulario/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<Formulario>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/Formulario/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/Formulario/{id}/Campos`

**path** `id`: `long`; **body** `model`: `SalvarCamposFormularioInputDTO` — [SalvarCamposFormularioInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-salvarcamposformularioinputdto).

**Retorno declarado:** `Task<ActionResult<Formulario>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/Formulario/Publico/{slug}`

**path** `slug`: `string`.

**Retorno declarado:** `Task<ActionResult<FormularioPublicoOutputDTO>>`. **Acesso:** Pública; não exige JWT nesta action.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/Formulario/Publico/{slug}/Envio`

**path** `slug`: `string`.

**Retorno declarado:** `Task<IActionResult>`. **Acesso:** Pública; não exige JWT nesta action.

[Voltar ao índice](#2-indice-clicavel)

### Cadastro de monitoramento no CRM — Monitoramento

**Uso encontrado nos clients:** Groner light. Compartilhamento não amplia permissões.

#### `GET /api/AbaComplementar/Monitoramento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<MonitoramentoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Monitoramento`

**query** `projetoId`: `long`.

**Retorno declarado:** `Task<ActionResult<MonitoramentoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Monitoramento/alertas`

**query** `monitoramentoId`: `long`; **query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `Task<ActionResult<PagedList<AlertaOutputDTO>>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/AbaComplementar/Monitoramento`

**body** `dto`: `MonitoramentoInputDTO` — [MonitoramentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-monitoramentoinputdto).

**Retorno declarado:** `Task<ActionResult<MonitoramentoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/AbaComplementar/Monitoramento/alerta`

**body** `dto`: `AlertaInputDTO` — [AlertaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-alertainputdto).

**Retorno declarado:** `Task<ActionResult<AlertaOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/AbaComplementar/Monitoramento/alerta/{id}`

**path** `id`: `long`; **body** `dto`: `AlertaInputDTO` — [AlertaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-alertainputdto).

**Retorno declarado:** `Task<ActionResult<AlertaOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/AbaComplementar/Monitoramento/alerta/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<string>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/AbaComplementar/Monitoramento/{id}`

**path** `id`: `long`; **body** `dto`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<MonitoramentoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Monitoramento/tipoAlerta`

**query** `pagingParams`: `PagingParams`; **query** `query`: `string`.

**Retorno declarado:** `Task<ActionResult<IList<TipoAlerta>>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/AbaComplementar/Monitoramento/tipoAlerta`

**body** `dto`: `TipoAlertaInputDTO` — [TipoAlertaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tipoalertainputdto).

**Retorno declarado:** `Task<ActionResult<TipoAlerta>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/AbaComplementar/Monitoramento/tipoAlerta`

**body** `dto`: `TipoAlerta` — [TipoAlerta](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-06-16y2x3u/#3-tipoalerta).

**Retorno declarado:** `Task<ActionResult<TipoAlerta>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/AbaComplementar/Monitoramento/tipoAlerta/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task<ActionResult<string>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

[Voltar ao índice](#2-indice-clicavel)

#### `GET /api/AbaComplementar/Monitoramento/TabelaAvancada`

**query** `loadOptions`: `DataSourceLoadOptions`.

**Retorno declarado:** `Task<LoadResult>`. **Acesso:** Acesso sujeito às regras do ambiente; use a credencial da integração e confirme a permissão desta operação.

[Voltar ao índice](#2-indice-clicavel)

### Automações da aba de monitoramento do CRM — AutomacoesStatusMonitoramento

#### `GET /api/AutomacoesStatusMonitoramento`

**query** `pagingParams`: `PagingParams`.

**Retorno declarado:** `ActionResult<PagedList<AutomacaoStatusMonitoramento>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

[Voltar ao índice](#2-indice-clicavel)

#### `POST /api/AutomacoesStatusMonitoramento`

**body** `model`: `AddAutomacaoStatusMonitoramentoInputDTO` — [AddAutomacaoStatusMonitoramentoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-01-12uez99/#3-addautomacaostatusmonitoramentoinputdto).

**Retorno declarado:** `Task<ActionResult<AutomacaoStatusMonitoramento>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `PUT /api/AutomacoesStatusMonitoramento/{id}`

**path** `id`: `long`; **body** `model`: `EditarPropriedadeInputDTO` — [EditarPropriedadeInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-02-1y50x5n/#3-editarpropriedadeinputdto).

**Retorno declarado:** `Task<ActionResult<AutomacaoStatusMonitoramento>>`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)

#### `DELETE /api/AutomacoesStatusMonitoramento/{id}`

**path** `id`: `long`.

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador.

[Voltar ao índice](#2-indice-clicavel)


<!-- groner-suporte:veja-tambem:inicio -->
## Veja também

* [Guia principal, autenticação e coleção Postman](https://ajuda.groner.app/pt-br/article/documentacao-da-api-groner-crm-vz2bq2/)
* [Como gerar token de API](https://ajuda.groner.app/pt-br/article/como-gerar-um-token-de-api-para-integrar-o-groner-com-outros-sistemas-2okhj6/)
* [Limites de requisições](https://ajuda.groner.app/pt-br/article/limites-de-requisicoes-da-api-da-groner-1cwtj65/)
<!-- groner-suporte:veja-tambem:fim -->