> ## 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 Serviços/OS — execução em campo e recursos compartilhados

Referência de **Serviços/OS** 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

[Usuários — Usuario](#3-usuarios-usuario) · [Lojas e filiais — Loja](#3-lojas-e-filiais-loja) · [Campos personalizados — CampoPersonalizado](#3-campos-personalizados-campopersonalizado) · [Documentos emitidos — Documento](#3-documentos-emitidos-documento) · [Arquivos e anexos — Arquivo](#3-arquivos-e-anexos-arquivo) · [Etiquetas — Etiqueta](#3-etiquetas-etiqueta) · [Pendências — Pendencia](#3-pendencias-pendencia) · [Ordens de serviço — OrdemServico](#3-ordens-de-servico-ordemservico) · [Instalação e obras — Instalacao](#3-instalacao-e-obras-instalacao) · [Equipes técnicas — EquipeTecnica](#3-equipes-tecnicas-equipetecnica) · [Tipos de serviço — TipoServico](#3-tipos-de-servico-tiposervico) · [Status de ordem de serviço — StatusOrdemServico](#3-status-de-ordem-de-servico-statusordemservico) · [Rotas de entrega — RotaEntrega](#3-rotas-de-entrega-rotaentrega) · [Veículos — Veiculo](#3-veiculos-veiculo) · [Automações de ordem de serviço — AutomacoesStatusOrdemServico](#3-automacoes-de-ordem-de-servico-automacoesstatusordemservico) · [Automações de instalação — AutomacoesStatusInstalacao](#3-automacoes-de-instalacao-automacoesstatusinstalacao)

---

## 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

### Consultar status de ordem de serviço

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

```bash
curl --request GET \
  --url "$API_URL/api/StatusOrdemServico?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
  }
}
```

Instalação e OS são operadas pelo Groner OS e também aparecem no CRM. Equipe, tipo de serviço, campos, arquivos e documentos são recursos reutilizados por vários produtos; seus IDs não pertencem a um módulo isolado.

---

## Referência dos endpoints

### Usuários — Usuario

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

#### `GET /api/Usuario`

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

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

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

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

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

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

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

#### `GET /api/Usuario/Localizacoes/{id}`

**path** `id`: `long`; **query** `dataInicial`: `DateTime?`; **query** `dataFinal`: `DateTime?`.

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

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

#### `GET /api/Usuario/ListaAtivosSimples`

**query** `query`: `string`.

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

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

#### `GET /api/Usuario/ListaTodosSimples`

**query** `somenteAtivos`: `bool?` (padrão `false`).

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

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

#### `GET /api/Usuario/PropriedadesParaModelo`

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

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

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

#### `GET /api/Usuario/TotalUsuarios`

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

**Retorno declarado:** `int`. **Acesso:** Pública; não exige JWT nesta action.

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

#### `GET /api/Usuario/TotalUsuariosAtivos`

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

**Retorno declarado:** `int`. **Acesso:** Pública; não exige JWT nesta action.

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

#### `GET /api/Usuario/LimiteUsuariosAtivos`

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

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/LimitesPorPerfil`

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

**Retorno declarado:** `Task<ActionResult<List<OcupacaoDePerfilOutputDTO>>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/Usuario/LimparCache`

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

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/TransferirTodosLeadsProjetoVendedor/{id}`

**path** `id`: `long`; **query** `usuarioDestinoId`: `long`; **query** `lojaDestinoId`: `long`; **query** `transferirComVenda`: `bool?` (padrão `true`).

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/TransferirTodosLeadsPreVendedor/{id}`

**path** `id`: `long`; **query** `usuarioDestinoId`: `long`; **query** `transferirComVenda`: `bool?` (padrão `true`).

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/TransferirTodosLeadsLoja/{id}`

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

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/AlterarStatusTodosProjetosVendedor/{id}`

**path** `id`: `long`; **query** `deStatusId`: `long`; **query** `paraStatusId`: `long`.

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/AlterarLojaTodosLeadsVendedor/{id}`

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

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/GerarLinkWhatsAppjs`

**query** `funcaoId`: `long?`; **query** `lojaId`: `long?`; **query** `texto`: `string`.

**Retorno declarado:** `Task<ActionResult>`. **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/Usuario/VerificarEmail/{email}`

**path** `email`: `string`.

**Retorno declarado:** `Task<ActionResult<UsuarioExistenteOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/Usuario/VerificarCelular/{celular}`

**path** `celular`: `string`.

**Retorno declarado:** `Task<ActionResult<UsuarioExistenteOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/Usuario/ObterDadosGoogle/{email}`

**path** `email`: `string`.

**Retorno declarado:** `Task<ActionResult>`. **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)

### Lojas e filiais — Loja

**Uso encontrado nos clients:** Groner agent-front, Groner editor, Groner erp, Groner light, Groner os. Compartilhamento não amplia permissões.

#### `GET /api/Loja`

**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<Loja>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Supervisor,Gerente.

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

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

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

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

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

#### `POST /api/Loja`

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

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

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

#### `PUT /api/Loja/{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<Loja>>`. **Acesso:** Bearer; perfis declarados: Administrador.

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

#### `PUT /api/Loja/EditarImagem/{id}`

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

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

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

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

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

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

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

#### `POST /api/Loja/AdicionarHorario/{id}`

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

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

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

#### `DELETE /api/Loja/{id}/RemoverHorario/{horarioId}`

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

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

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

#### `GET /api/Loja/{id}/CopiarDadosProposta/{idLojaOrigem}`

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

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

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

#### `POST /api/Loja/Duplicar/{id}`

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

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

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

#### `GET /api/Loja/PropriedadesParaModelo`

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

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

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

#### `GET /api/Loja/ListaTimezones`

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

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

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

#### `POST /api/Loja/AdicionarIrradiacao12Meses/{id}`

**path** `id`: `long`; **query** `consumo`: `double`.

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

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

#### `POST /api/Loja/RemoverIrradiacao12Meses/{id}`

**path** `id`: `long`; **query** `consumo`: `double`.

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

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

#### `PUT /api/Loja/EditarEndereco/{id}`

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

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

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

### Campos personalizados — CampoPersonalizado

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

#### `GET /api/CampoPersonalizado`

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

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

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

#### `GET /api/CampoPersonalizado/TabelaAvancada`

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

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

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

#### `GET /api/CampoPersonalizado/CamposRespostas`

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

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

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

#### `GET /api/CampoPersonalizado/Projeto/{projetoId}`

**path** `projetoId`: `long`; **query** `abaDinamicaId`: `long?` (padrão `null`); **query** `tipoServicoId`: `long?` (padrão `null`); **query** `ordemServicoId`: `long?` (padrão `null`); **query** `tipoTarefaId`: `long?` (padrão `null`); **query** `tarefaId`: `long?` (padrão `null`); **query** `camposIds`: `List<long>` (padrão `null`).

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

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

#### `GET /api/CampoPersonalizado/Projeto/{projetoId}/Agrupado`

**path** `projetoId`: `long`.

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

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

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

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

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

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

#### `POST /api/CampoPersonalizado`

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

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

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

#### `PUT /api/CampoPersonalizado/{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<CampoPersonalizado>>`. **Acesso:** Bearer; perfis declarados: Administrador.

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

#### `PUT /api/CampoPersonalizado/Editar/{id}`

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

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

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

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

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

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

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

#### `POST /api/CampoPersonalizado/{id}/AdicionarOpcao`

**path** `id`: `long`; **body** `model`: `OpcaoCampoInputDTO` — [OpcaoCampoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-04-62zu2h/#3-opcaocampoinputdto).

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

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

#### `DELETE /api/CampoPersonalizado/{id}/RemoverOpcao/{opcao}`

**path** `id`: `long`; **path** `opcao`: `string`.

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

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

#### `POST /api/CampoPersonalizado/{id}/Responder`

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

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

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

#### `POST /api/CampoPersonalizado/{id}/CalcularFormula`

**path** `id`: `long`; **query** `projetoId`: `long`; **query** `ordemServicoId`: `long?`; **query** `tarefaId`: `long?`.

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

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

#### `PUT /api/CampoPersonalizado/Resposta/{respostaId}`

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

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

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

#### `POST /api/CampoPersonalizado/AdicionarFuncao/{id}`

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

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

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

#### `POST /api/CampoPersonalizado/RemoverFuncao/{id}`

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

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

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

#### `POST /api/CampoPersonalizado/AdicionarFuncaoEditar/{id}`

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

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

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

#### `POST /api/CampoPersonalizado/RemoverFuncaoEditar/{id}`

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

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

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

#### `GET /api/CampoPersonalizado/Resposta/{projetoId}/Campo/{campoId}`

**path** `projetoId`: `long`; **path** `campoId`: `long`; **query** `ordemServicoId`: `long?`; **query** `tarefaId`: `long?`.

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

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

#### `GET /api/CampoPersonalizado/Interpolacoes`

**query** `tipo`: `TipoCampoPersonalizadoEnum`.

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

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

#### `GET /api/CampoPersonalizado/CardsIniciais`

**query** `etapaId`: `long`; **query** `somenteAtivos`: `bool?`.

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

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

#### `GET /api/CampoPersonalizado/ResponderCamposHTML`

**query** `projetoId`: `long`; **query** `ordemServicoId`: `long?` (padrão `null`); **query** `abaDinamicaId`: `long?` (padrão `null`); **query** `tipoServicoId`: `long?` (padrão `null`); **query** `corBotao`: `string` (padrão `null`).

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

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

#### `POST /api/CampoPersonalizado/ResponderFormulario`

**body** `model`: `ResponderFormularioCampoPersonalizadoInputDTO` — [ResponderFormularioCampoPersonalizadoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-responderformulariocampopersonalizadoinputdto).

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

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

#### `GET /api/CampoPersonalizado/PropriedadesVinculadasPossiveis`

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

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

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

#### `GET /api/CampoPersonalizado/DestinosVinculaveis`

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

**Retorno declarado:** `Task<List<DestinoFormulario>>`. **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)

### Documentos emitidos — Documento

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

#### `GET /api/Documento`

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

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

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

#### `GET /api/Documento/Geral`

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

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

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

#### `GET /api/Documento/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/Documento/Summary`

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

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

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

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

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

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

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

#### `POST /api/Documento`

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

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

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

#### `PUT /api/Documento/{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<Documento>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

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

#### `GET /api/Documento/LimparCache/{id}`

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

**Retorno declarado:** `Task<ActionResult<Projeto>>`. **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)

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

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

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

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

#### `GET /api/Documento/VisualizarHTML/{id}`

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

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

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

#### `GET /api/Documento/VisualizarDemoHtml`

**query** `modeloId`: `long?`.

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

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

#### `GET /api/Documento/GerarPDF/{id}`

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

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

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

#### `GET /api/Documento/GerarPDFDoc/{id}`

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

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

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

#### `GET /api/Documento/EnviarClickSign/{id}`

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

**Retorno declarado:** `Task<Documento>`. **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)

#### `POST /api/Documento/EnviarClickSignLote`

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

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

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

#### `GET /api/Documento/CancelaDocumentoClickSign/{id}`

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

**Retorno declarado:** `Task<DocumentClickSignOutPutDTO>`. **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/Documento/FinalizaDocumentoClickSign/{id}`

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

**Retorno declarado:** `Task<DocumentClickSignOutPutDTO>`. **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/Documento/VerificarDocumentoClickSign/{id}`

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

**Retorno declarado:** `Task<DocumentClickSignOutPutDTO>`. **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)

#### `DELETE /api/Documento/ExcluirDocumentoClickSign/{id}`

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

**Retorno declarado:** `Task<Documento>`. **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)

#### `POST /api/Documento/WebHookClickSign`

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

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

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

### Arquivos e anexos — Arquivo

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

#### `POST /api/Arquivo`

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

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

**Transporte:** `multipart/form-data` — campo de arquivo `file`.

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

#### `GET /api/Arquivo`

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

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

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

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

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

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

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

#### `GET /api/Arquivo/DownloadArquivosProjeto/{id}`

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

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

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

#### `GET /api/Arquivo/DownloadArquivosOrdemServico/{id}`

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

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

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

#### `POST /api/Arquivo/DownloadArquivosPorIds`

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

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

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

#### `GET /api/Arquivo/{id}/Arquivamento`

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

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

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

#### `POST /api/Arquivo/Arquivamento`

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

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

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

#### `GET /api/Arquivo/Arquivamento/Projeto/{projetoId}`

**path** `projetoId`: `long`.

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

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

#### `GET /api/Arquivo/Restauracao/Condicoes`

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

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

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

#### `POST /api/Arquivo/{id}/Restaurar`

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

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

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

#### `POST /api/Arquivo/RestaurarPorProjeto/{projetoId}`

**path** `projetoId`: `long`; **query** `imediata`: `bool` (padrão `false`).

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

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

#### `POST /api/Arquivo/Restaurar`

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

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

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

#### `GET /api/Arquivo/Arquivamento/Modelo/{tipo}/{modeloId}`

**path** `tipo`: `TipoModeloRestauracaoEnum`; **path** `modeloId`: `long`.

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

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

#### `POST /api/Arquivo/Restaurar/Modelo/{tipo}/{modeloId}`

**path** `tipo`: `TipoModeloRestauracaoEnum`; **path** `modeloId`: `long`.

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

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

#### `GET /api/Arquivo/EspacoUtilizadoArquivos`

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

**Retorno declarado:** `Task<ActionResult<EspacoOcupadoOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/Arquivo/EspacoUtilizadoPropostasDocumentos`

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

**Retorno declarado:** `Task<ActionResult<EspacoOcupadoOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/Arquivo/EspacoContratado`

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

**Retorno declarado:** `Task<ActionResult>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `PUT /api/Arquivo/{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<Arquivo>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Gerente,Tecnico,Supervisor.

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

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

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

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

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

#### `DELETE /api/Arquivo/NaoUtilizadas`

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

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

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

#### `GET /api/Arquivo/RecuperaArquivosExcluidos`

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

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

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

### Etiquetas — Etiqueta

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

#### `GET /api/Etiqueta`

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

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

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

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

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

**Retorno declarado:** `ActionResult<Etiqueta>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Gerente.

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

#### `POST /api/Etiqueta`

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

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

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

#### `PUT /api/Etiqueta/{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<Etiqueta>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Gerente.

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

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

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

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

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

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

**path** `id`: `long`; **query** `idsFuncoes`: `List<long>`.

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

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

### Pendências — Pendencia

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

#### `GET /api/Pendencia`

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

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

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

#### `GET /api/Pendencia/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/Pendencia/Summary`

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

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

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

#### `GET /api/Pendencia/PorTitulo`

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

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

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

#### `GET /api/Pendencia/Cadencias`

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

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

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

#### `GET /api/Pendencia/LogEnvios`

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

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

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

#### `POST /api/Pendencia/{id}/CancelarCadencia`

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

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

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

#### `POST /api/Pendencia/{id}/PularLembrete`

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

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

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

#### `POST /api/Pendencia/{id}/Reprocessar`

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

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

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

#### `POST /api/Pendencia/ReprocessarLote`

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

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

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

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

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

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

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

#### `POST /api/Pendencia`

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

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

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

#### `POST /api/Pendencia/PreviewMensagemIA`

**body** `model`: `PreviewMensagemIAInputDTO` — [PreviewMensagemIAInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-previewmensagemiainputdto).

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

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

#### `PUT /api/Pendencia/{id}/Editar`

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

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

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

#### `PUT /api/Pendencia/{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<Pendencia>>`. **Acesso:** Bearer; perfis declarados: Administrador,PreVendedor,Vendedor,Tecnico,Gerente,Supervisor.

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

#### `DELETE /api/Pendencia/{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/Pendencia/Resolver/{id}`

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

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

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

#### `POST /api/Pendencia/Validar/{id}`

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

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

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

#### `POST /api/Pendencia/Conferir/{id}`

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

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

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

#### `POST /api/Pendencia/Reabrir/{id}`

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

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

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

### Ordens de serviço — OrdemServico

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

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

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/Ordens`

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/AllOrdens`

**query** `filtro`: `FiltroOrdemServicoInputDTO` — [FiltroOrdemServicoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtroordemservicoinputdto); **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)

#### `POST /api/AbaComplementar/OrdemServico`

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

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

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

#### `POST /api/AbaComplementar/OrdemServico/Bulk`

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

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

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

#### `PUT /api/AbaComplementar/OrdemServico/{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)

#### `POST /api/AbaComplementar/OrdemServico/AlterarStatusEmLote`

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

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

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

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

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

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

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

#### `POST /api/AbaComplementar/OrdemServico/{id}/Faturar`

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/{id}/Financeiro`

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

**Retorno declarado:** `Task<ActionResult<FinanceiroOrdemServicoDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

#### `POST /api/AbaComplementar/OrdemServico/{id}/GerarRepasseEquipe`

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

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

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

#### `POST /api/AbaComplementar/OrdemServico/EmitirNota`

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/AFaturar`

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

**Retorno declarado:** `Task<ActionResult<PagedList<OrdemServicoAFaturarDTO>>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

#### `GET /api/AbaComplementar/OrdemServico/AFaturar/Resumo`

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/Erp`

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

**Retorno declarado:** `Task<ActionResult<PagedList<OrdemServicoErpDTO>>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

#### `GET /api/AbaComplementar/OrdemServico/Erp/Resumo`

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

**Retorno declarado:** `Task<ActionResult<ResumoOrdemServicoErpDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

#### `GET /api/AbaComplementar/OrdemServico/Erp/Opcoes`

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

**Retorno declarado:** `Task<ActionResult<OpcoesOrdemServicoErpDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

#### `POST /api/AbaComplementar/OrdemServico/Faturar`

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

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

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

#### `POST /api/AbaComplementar/OrdemServico/FaturarEmLote`

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/{id}/FaturamentoPreview`

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/AgrupadoPor`

**query** `grupo`: `GrupoOrdemServico`; **query** `filtro`: `FiltroOrdemServicoInputDTO` — [FiltroOrdemServicoInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-03-186hp04/#3-filtroordemservicoinputdto); **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)

#### `GET /api/AbaComplementar/OrdemServico/Mapa`

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

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

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

#### `GET /api/AbaComplementar/OrdemServico/Summary`

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

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

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

#### `POST /api/AbaComplementar/OrdemServico/VerificarConflito`

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

**Retorno declarado:** `Task<IActionResult>`. **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/OrdemServico/TecnicoComDisponibilidade`

**query** `data`: `DateTime`.

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

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

#### `GET /api/AbaComplementar/OrdemServico/TecnicoValidarDisponibilidade`

**query** `tecnicoId`: `long`; **query** `data`: `DateTime`.

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

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

#### `GET /api/AbaComplementar/OrdemServico/EquipesComDisponibilidade`

**query** `data`: `DateTime`.

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

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

#### `GET /api/AbaComplementar/OrdemServico/EquipeValidarDisponibilidade`

**query** `equipeId`: `long`; **query** `data`: `DateTime`.

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

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

#### `GET /api/AbaComplementar/OrdemServico/PropriedadesParaModelo`

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

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

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

#### `POST /api/AbaComplementar/OrdemServico/CalcularRotaOtimizada`

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

**Retorno declarado:** `Task<IActionResult>`. **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/OrdemServico/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)

### Instalação e obras — Instalacao

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

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

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

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

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

#### `GET /api/AbaComplementar/Instalacao`

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

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

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

#### `GET /api/AbaComplementar/Instalacao/Geral`

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

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

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

#### `GET /api/AbaComplementar/Instalacao/Summary`

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

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

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

#### `GET /api/AbaComplementar/Instalacao/diarios`

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

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

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

#### `POST /api/AbaComplementar/Instalacao`

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

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

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

#### `PUT /api/AbaComplementar/Instalacao`

**query** `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<InstalacaoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

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

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

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

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

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

#### `PUT /api/AbaComplementar/Instalacao/{id}/restaurar`

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

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

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

#### `POST /api/AbaComplementar/Instalacao/diario`

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

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

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

#### `PUT /api/AbaComplementar/Instalacao/diario/{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<InstalacaoOutputDTO>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,PreVendedor,Vendedor,Gerente,Tecnico.

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

#### `DELETE /api/AbaComplementar/Instalacao/diario/{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/Instalacao/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)

### Equipes técnicas — EquipeTecnica

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

#### `GET /api/EquipeTecnica`

**query** `pagingParams`: `PagingParams`; **query** `query`: `string`; **query** `setorId`: `long?`.

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

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

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

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

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

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

#### `POST /api/EquipeTecnica`

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

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

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

#### `PUT /api/EquipeTecnica/{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<EquipeTecnica>>`. **Acesso:** Bearer; perfis declarados: Administrador,Vendedor,PreVendedor,Supervisor, Tecnico,Gerente.

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

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

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

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

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

#### `POST /api/EquipeTecnica/AdicionarHorario/{id}`

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

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

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

#### `DELETE /api/EquipeTecnica/{id}/RemoverHorario/{horarioId}`

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

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

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

### Tipos de serviço — TipoServico

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

#### `GET /api/TipoServico`

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

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

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

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

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

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

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

#### `POST /api/TipoServico`

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

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

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

#### `PUT /api/TipoServico/{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<TipoServico>>`. **Acesso:** Bearer; perfis declarados: Administrador.

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

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

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

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

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

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

**path** `id`: `long`; **query** `idsFuncoes`: `List<long>`.

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

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

#### `POST /api/TipoServico/Duplicar/{id}`

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

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

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

#### `POST /api/TipoServico/CopiarCamposPersonalizados`

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

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

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

### Status de ordem de serviço — StatusOrdemServico

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

#### `GET /api/StatusOrdemServico`

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

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

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

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

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

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

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

#### `POST /api/StatusOrdemServico`

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

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

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

#### `PUT /api/StatusOrdemServico/{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<StatusOrdemServico>>`. **Acesso:** Bearer; perfis declarados: Administrador.

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

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

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

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

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

#### `GET /api/StatusOrdemServico/TiposStatus`

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

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

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

### Rotas de entrega — RotaEntrega

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

#### `GET /api/RotaEntrega/Pendencias`

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

**Retorno declarado:** `Task<ActionResult<PagedList<PendenciaEntregaOutputDTO>>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/Pendencias/GerarReposicao`

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

**Retorno declarado:** `Task<ActionResult<GerarReposicaoOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/RotaEntrega`

**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<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/RotaEntrega/Minhas`

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

**Retorno declarado:** `Task<ActionResult<List<dynamic>>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

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

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

**Retorno declarado:** `Task<ActionResult<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/RotaEntrega/{id}/Detalhe`

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

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega`

**body** `model`: `RotaEntregaInputDTO` — [RotaEntregaInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-rotaentregainputdto).

**Retorno declarado:** `Task<ActionResult<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `PUT /api/RotaEntrega/{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<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/{id}/Compras`

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

**Retorno declarado:** `Task<ActionResult<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/RotaEntrega/PedidosVenda`

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

**Retorno declarado:** `Task<ActionResult<PagedList<PedidoVendaFilaOutputDTO>>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `GET /api/RotaEntrega/PedidosVenda/Regioes`

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

**Retorno declarado:** `Task<ActionResult<List<RegiaoPedidosVendaOutputDTO>>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/{id}/PedidosVenda`

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

**Retorno declarado:** `Task<ActionResult<AdicionarPedidosVendaOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/PedidosVenda/Segurar`

**body** `model`: `SegurarEntregasInputDTO` — [SegurarEntregasInputDTO](https://ajuda.groner.app/pt-br/article/api-groner-contratos-referencia-05-1euyfrd/#3-segurarentregasinputdto).

**Retorno declarado:** `Task<ActionResult<SegurarEntregasOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/Entregas/{entregaId}/Liberar`

**path** `entregaId`: `long`.

**Retorno declarado:** `Task<ActionResult<LiberarEntregaOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `DELETE /api/RotaEntrega/{id}/Entregas/{entregaId}`

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

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `DELETE /api/RotaEntrega/{id}/Compras/{compraId}`

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

**Retorno declarado:** `Task<ActionResult<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/{id}/Ordenar`

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

**Retorno declarado:** `Task<ActionResult<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/{id}/Iniciar`

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

**Retorno declarado:** `Task<ActionResult<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/Entregas/{entregaId}/Despachar`

**path** `entregaId`: `long`.

**Retorno declarado:** `Task<ActionResult<DespachoEntregaOutputDTO>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/{id}/Entregas/{entregaId}/NaoEntregue`

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

**Retorno declarado:** `Task<ActionResult<RotaEntrega>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/MigrarEntregas`

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

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

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

#### `POST /api/RotaEntrega/Otimizar`

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

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/AplicarOtimizacao`

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

**Retorno declarado:** `Task<ActionResult<List<RotaEntrega>>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

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

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

**Retorno declarado:** `Task`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/{id}/Entregas/{entregaId}/Mover`

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

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

#### `POST /api/RotaEntrega/{id}/Restaurar`

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

**Retorno declarado:** `Task<ActionResult<dynamic>>`. **Acesso:** Bearer; permissões do usuário e do módulo.

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

### Veículos — Veiculo

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

#### `GET /api/Veiculo`

**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<Veiculo>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

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

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

**Retorno declarado:** `ActionResult<Veiculo>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

#### `POST /api/Veiculo`

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

**Retorno declarado:** `Task<ActionResult<Veiculo>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

#### `PUT /api/Veiculo/{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<Veiculo>>`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

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

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

**Retorno declarado:** `Task`. **Acesso:** Bearer; perfis declarados: Administrador,Supervisor,Operador ERP.

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

### Automações de ordem de serviço — AutomacoesStatusOrdemServico

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

#### `GET /api/AutomacoesStatusOrdemServico`

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

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

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

#### `POST /api/AutomacoesStatusOrdemServico`

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

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

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

#### `PUT /api/AutomacoesStatusOrdemServico/{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<AutomacaoStatusOrdemServico>>`. **Acesso:** Bearer; perfis declarados: Administrador.

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

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

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

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

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

### Automações de instalação — AutomacoesStatusInstalacao

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

#### `GET /api/AutomacoesStatusInstalacao`

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

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

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

#### `POST /api/AutomacoesStatusInstalacao`

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

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

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

#### `PUT /api/AutomacoesStatusInstalacao/{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<AutomacaoStatusInstalacao>>`. **Acesso:** Bearer; perfis declarados: Administrador.

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

#### `DELETE /api/AutomacoesStatusInstalacao/{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 -->